ModdingWiki - User contributions [en-gb]

Duke Nukem 3D

2019-07-25T04:35:09Z

Jaguar: Added Palette formats link

{{Stub}}

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

== Tools ==

{{BeginFileFormatTools|Type=game}}
{{FileFormatTool
| Name = [[Build]]
| Platform = DOS
| grp = No
| map = Edit
| gfx = View
| mus = No
| sfx = No
| txt = No
| sav = No
| exe = No
}}
{{FileFormatTool
| Name = [[Camoto]]
| Platform = Linux/Windows
| grp = Edit
| map = No
| gfx = No
| mus = No
| sfx = No
| txt = No
| sav = No
| exe = No
}}
{{FileFormatTool
| Name = EditART
| Platform = DOS
| grp = No
| map = No
| gfx = Yes
| mus = No
| sfx = No
| txt = No
| sav = No
| exe = No
}}
{{FileFormatTool
| Name = [https://gist.github.com/jasonsperske/31324a0cdffd8edf9683 GRPParser.py]
| Platform = Python
| grp = Read
| map = Convert to .svg
| gfx = No
| mus = No
| sfx = No
| txt = No
| sav = No
| exe = No
}}
{{FileFormatTool
| Name = Kextract/Kgroup
| Platform = DOS
| grp = Edit
| map = No
| gfx = No
| mus = No
| sfx = No
| txt = No
| sav = No
| exe = No
}}
{{EndFileFormatTools}}

== Links ==

* [http://dukenukem.wikia.com/wiki/Portal:Duke_Nukem_3D Duke Nukem 3D portal] on the Duke Nukem wiki
* [http://dukeworld.duke4.net/ Dukeworld] on [http://duke4.net Duke4.net]

{{BeginGameFileList}}
{{GameFile
| Name = *.anm
| Format = [[ANM Format (Duke Nukem 3D)]]
| KnownFormat = Yes
| Desc = Intro and story cutscenes
}}
{{GameFile
| Name = *.art
| Format = [[ART Format (Build)]]
| KnownFormat = Yes
| Desc = Level textures
}}
{{GameFile
| Name = *.bin
| Format = [[B800 Text]]
| KnownFormat = Yes
| Desc = Exit text screens
}}
{{GameFile
| Name = *.con
| Format = ASCII text in [[CON Format]]
| KnownFormat = Yes
| Desc = Game parameters and scripting
}}
{{GameFile
| Name = *.dmo
| Format = [[DMO Format (Build)]]
| KnownFormat = No
| Desc = Demo macros
}}
{{GameFile
| Name = *.grp
| Format = [[GRP Format]]
| KnownFormat = Yes
| Desc = Archive storing most of the game's data files
}}
{{GameFile
| Name = *.map
| Format = [[MAP Format (Build)]]
| KnownFormat = Yes
| Desc = Game levels
}}
{{GameFile
| Name = *.mid
| Format = [[MID Format]]
| KnownFormat = Yes
| Desc = Background music
}}
{{GameFile
| Name = *.rts
| Format = [[RTS Format]]
| KnownFormat = Yes
| Desc = ''RemoteRidicule'' multiplayer audio taunts
}}
{{GameFile
| Name = gmtimbre.tmb
| Format = [[TMB Format]]
| KnownFormat = Yes
| Desc = FM patches for MIDI music
}}
{{GameFile
| Name = *.voc
| Format = [[VOC Format]]
| KnownFormat = Yes
| Desc = Sound effects
}}
{{GameFile
| Name = palette.dat lookup.dat
| Format = [[Duke Nukem 3D Palette Format]]
| KnownFormat = Yes
| Desc = Palette data for sprites and textures
}}
{{EndGameFileList}}

== Modding tips ==
* The game directory is searched for files before looking inside DUKE3D.GRP. This means when you replace a file you don't need to copy it inside DUKE3D.GRP to test it.
* The game has a command-line option to load custom .GRP files. This means you can package your mod into a single GRP file and distribute it easily. Any game files not in your .GRP file will be loaded from the main DUKE3D.GRP.

[[Category:3DRealms]]
[[Category:3D]]
[[Category:First-Person Shooter]]
[[Category:Build engine]]

Duke Nukem 3D Palette Format

2019-07-25T02:55:32Z

Jaguar: Created Palette page

{{Palette Infobox
| Hardware = VGA
| Depth = 18-bit
| Count = 256
}}

Duke Nukem 3D stores its palette information in the files ''PALETTE.DAT'' and ''LOOKUP.DAT''. The game only uses 256 colours, but uses various lookup tables to give the appearance of varying levels and colours of light.

''PALETTE.DAT'' contains the palette for the entire game along with shading and translucency lookups.

''LOOKUP.DAT'' contains the lookup tables for the various virtual palettes used within the game other than palette 0.

==PALETTE.DAT format==

''PALETTE.DAT'' is made up of 3 sections; Palette data, shade tables and a translucency table.

{|class="wikitable"
! Data type !! Name !! Description
|-
| [[UINT8]] [256][3] || palette || The game palette data stored as a standard [[VGA_Palette#The "Classic" format|6-bit VGA palette]].
|-
| [[INT16LE]] || numpalookups || The number of palette lookup tables in the file
|-
| [[UINT8]] [numpalookups][256] || palookup || Array of simple lookup tables for each palette entry
|-
| [[UINT8]] [256][256] || transluc || 2-dimensional array to find the blended result of two palette entries
|}

===Shade Tables===

The shade tables are simple lookup tables that translate a given palette entry to its equivalent at a given level of darkness.

===Translucency Table===

The translucency table is a 2-dimensional array that gives a result when two palette entries are alpha-blended together.

==LOOKUP.DAT format==

''LOOKUP.DAT'' is made up of 2 sections; Palette swap tables and alternate palettes. Alternate palettes are used for full-screen animations such as the title screen and episode cut-scenes

{|class="wikitable"
! Data type !! Name !! Description
|-
| [[UINT8]] || spritepals || The number of palette lookup tables in the file
|-
| PALETTE_SWAP [spritepals] || palette_swaps|| Array of simple lookup tables for each palette entry
|-
| [[UINT8]] [n][256][3] || alt_palettes || Animation palettes stored as a standard [[VGA_Palette#The "Classic" format|6-bit VGA palette]]. These palettes take up the remainder of the file
|}

===Palette Swap format===

Each PALETTE_SWAP is defined as the following 257-byte structure:

{|class="wikitable"
! Data type !! Name !! Description
|-
| [[UINT8]] || palette_swap_index || The index of this palette in the game
|-
| [[UINT8]] [256] || palette_swap_table|| Lookup table for this palette
|}

ART Format (Build)

2019-07-24T06:13:50Z

Jaguar: /* Tile Attributes */ Re-ordered attributes to match buildinf.txt, line 65-84

{{Tileset Infobox
| Hardware1 = VGA
| MaxTiles = 231 - 1
| Palette = Shared VGA
| Names = N
| TileMinSize = 0×0
| TileMaxSize = 32767×32767
| NumPlanes = 1
| PlaneArrangement = [[Linear VGA]]
| HasTransparency = N
| HasHitmap = N
| Metadata = None
| Subtilesets = N
| Compressed = N
| Hidden = N
| Games =
{{Game|Blood}}
{{Game|Duke Nukem 3D}}
{{Game|Shadow Warrior}}
{{Game|Redneck Rampage}}
}}
The '''ART format''' is used by Ken Silverman's Build engine to store game textures and sprites. It contains a number of individual graphics called tiles.

== File Names and Tile Numbers ==
According to Ken Silverman's documentation, ART files can be named anything, as long as they end in three digits and .ART, but for most games they are named TILES###.ART. The Build engine games will load these in order starting from 000 until they can't find any more. Every tile in the game has a numerical index, and each ART file for a particular game holds a range of these. For example, TILES000.ART may hold tiles 0 to 255, and TILES001.ART would hold tiles 256-511. The range of indexes held by a particular file are indicated in the header. The tiles are normally stored sequentially (TILES000.ART holding the first set, and each higher numbered file continuing where the previous left off) with a consistent number of tiles per file, but it is up to the particular game's developers.

== Header ==

{|class="wikitable"
! Data Type !! Name !! Description
|-
| [[INT32LE]]
| artversion
| version number, should be 1
|-
| [[INT32LE]]
| numtiles
| number of tiles, unused. The number of tiles can be determined by the localtilestart and localtileend fields.
|-
| [[INT32LE]]
| localtilestart
| number of first tile in this file
|-
| [[INT32LE]]
| localtileend
| number of last tile in this file.
|-
| [[INT16LE]][localtileend-localtilestart + 1]
| tilesizx
| array of the x-dimensions of all of the tiles in the file
|-
| [[INT16LE]][localtileend-localtilestart + 1]
| tilesizy
| array of the y-dimensions of all of the tiles in the file
|-
| [[INT32LE]][localtileend-localtilestart + 1]
| picanm
| array of attributes for all the tiles
|}

== Tile Attributes ==

Entries in the picanm array store several properties for each tile:

{|class="wikitable"
|-
! bits 31-28
! bits 27-24 (4 bit unsigned integer)
! bits 23-16 (8 bit signed integer)
! bits 15-8 (8 bit signed integer)
! bits 7 and 6 (2 bit enumeration)
! bits 5-0 (6-bit unsigned integer)

|-
| unused?
| Animation speed
| Y-center offset
| X-center offset
| Animation type:
* 00 = no animation
* 01 = oscillating animation
* 10 = animate forward
* 11 = animate backward
| Number of frames
|}

== Pixel Data ==

The pixels are stored as bytes, corresponding to indexes in the palette stored in PALETTE.DAT. The pixels in each tile are stored columnwise, starting from the top-left. For a 4x4 tile, the offsets for each pixel would be arranged like this:

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

== Source ==

* This information comes from <tt>[https://github.com/jonof/jfbuild/blob/master/doc/buildinf.txt BUILDINF.TXT]</tt> in the [http://advsys.net/ken/buildsrc/default.htm Build source] files, written by Ken Silverman.

[[Category:Build engine]]

Jill of the Jungle Map Format

2013-05-31T23:20:09Z

Jaguar: /* Items & Bonus */ Corrected speling mistake

{{Stub}}

The '''Jill of the Jungle map format''' is the format used to describe the levels played during the game. The maps contain two layers - a background layer and an "object" layer. The background layer is a grid of 16x16 pixel tiles, 128 tiles wide and 64 tiles high. The object layer is made up of an arbitrary list of objects, with X and Y offsets in pixels.

== File format ==

The main map file starts off with the background layer, then immediately following it is the foreground layer, the savegame data block and the string stack.

=== Background layer ===

The background layer is quite simple. It is an array of 8,192 16-bit values (128 tiles wide by 64 tiles high == 8192 tiles total.) Each 16-bit value is a code, such as 0xC0D3. The formula ((x * MAP_HEIGHT) + y) * 2 (where MAP_HEIGHT is 64) will provide the offset (in bytes) into the map file where that grid's 16-bit code is located.

Once the code is found, its lower three nybbles are isolated (e.g. code & 0xFFF) which provides an ID that is listed in the tile mapping table (see below.) The tile mapping table then provides an index into the graphics file for the image that should be displayed at that grid location.

For example, if the 16-bit code is 0xC0D3, then isolating the lower three nybbles will provide the number 0x00D3. At the entry for ID 0x00D3 in the tile mapping table, the value might be iTileset as 0x12 and iTile as 0x34. This means that in the graphics file, tileset number 0x12 should be accessed, and tile number 0x34 within that tileset should be drawn at the grid coordinate.

It is also important to note that these values are stored little-endian, like the [[SHA Format|SHA format]]. This means that for example the value 0xC0D3 is stored as the two bytes D3-C0, not as C0-D3.

==== Tile mapping table ====

There is a separate file in the game directory that contains mappings between tile codes in the background layer and the game's graphics. In [[Jill of the Jungle]] this is called <tt>JILL.DMA</tt> and in [[Xargon]] it is <tt>TILES.XRx</tt>.

This file is arranged as an array of entries, one after the other. Each entry is in the following format:

{|class="wikitable"
!Data type!!Description
|-
| [[UINT16LE]] iMapCode || ID used in map file
|-
| [[UINT8]] iTile || Index into the tileset for the image to use
|-
| [[UINT8]] iTileset || Index of tileset containing this tile's image (ignore upper two bits - see below)
|-
| [[UINT16LE]] iFlags || Flags for this tile (can stand on, can hurt player, etc.)
|-
| [[UINT8]] iLength || Length of tile name
|-
| [[char]] cName[iLength] || <tt>iLength</tt> characters for the tile name. This string is not NULL-terminated.
|}

Note that only the lower six bits of <tt>iTileset</tt> refer to the tile number. The purpose of the upper unknown bits is unknown. To get a valid tileset index use <code>iTileset & 0x3F</code>.

<tt>iFlags</tt> is broken up as follows:

{|class="wikitable"
!Bit!!Hex!!Name!!Description
|-
||-||0x0000||<zero>||Default solid block
|-
|1||0x0001||F_PLAYERTHRU||Blocks you can walk, jump or fall through (background tiles, the path on the overhead map, etc.)
|-
|2||0x0002||F_STAIR, F_NOTSTAIR (Xargon)||Blocks that you can stand on (can also jump up through when combined with F_PLAYERTHRU)
|-
|3||0x0004||F_VINE, F_NOTVINE (Xargon)||Can climb this block - usually combined with F_PLAYERTHRU (giving 0x0005)
|-
|4||0x0008||F_MSGTOUCH||Activates game-specific code when touched
|-
|5||0x0010||F_MSGDRAW|| Regular blocks have just one shape, f_msgdraw triggers <tt>msg_block(msg_draw)</tt> for animated blocks.
|-
|6||0x0020||F_MSGUPDATE|| game-specific code (through <tt>msg_block(msg_update)</tt>) at every frame. For animated blocks.
|-
|7||0x0040||F_INSIDE||This block contains text inside it
|-
|8||0x0080||F_FRONT|| object property : Foreground object
|-
|9||0x0100||F_TRIGGER||Unknown
|-
|10||0x0200||F_BACK || object property: Background object (e.g. torches)
|-
|10||0x0200||F_TINYTHRU|| (likely PlayerThru when player is in 'mini' mode, unused in Xargon)
|-
|11||0x0400||F_ALWAYS|| object property : "Always updates object"
|-
|12||0x0800||F_KILLABLE|| object property : monster can be killed with regular weapon.
|-
|13||0x1000||F_FIREBALL|| object property : object is a fireball
|-
|14||0x2000||F_WATER|| A water tile. regular player will sink, the S.U.B. and aquatic monster can swim through it, but not out of it
|-
|14||0x4000||F_NOT_WATER|| (Xargon) Not a water tile.
|-
|15||0x4000||F_WEAPON|| object property : object is a regular weapon
|-
|16||0x8000||(unused)||(unused)
|}

Note that the same "flag set" is used for both blocks and objects. Some properties only apply to blocks, some only apply to objects, some to both (<tt>f_msgtouch</tt>), and some flags have a different meaning for blocks and tile (e.g. 0x200 and 0x2000).

=== Object layer ===

The object layer is drawn in front of the background layer, and contains all the interactive elements of the map, such as points and enemies.

The object data starts straight after the background layer data, so that's at offset 16,384 bytes into the map file (8,192 tiles * two bytes per tile.) The first two bytes in the object layer are a 16-bit integer ([[UINT16LE]]) that stores the number of objects in the map, and this is followed by the data for each object, one after the other.

Each object is 31 bytes long, and is stored in the following structure:

{|class="wikitable"
!Data type!!Description
|-
|UINT8 iType||Object type (e.g. a "point item", or an enemy.)
|-
|UINT16 iX||X-coordinate of object
|-
|UINT16 iY||Y-coordinate of object
|-
|UINT16 iXD|| object horizontal speed
|-
|UINT16 iYD|| object vertical speed
|-
|UINT16 iWidth||Width of object
|-
|UINT16 iHeight||Height of object
|-
|UINT16 iState||Object sub-type (e.g. what type of "point item"), or current "State" (running, jumping, etc)
|-
|UINT16 iSubState||object-specific semantic
|-
|UINT16 iStateCount||object-specific semantic, typically a frame counter
|-
|UINT16 iCounter||Various uses. Often used to link doors or switches to obstacles.
|-
|UINT16 iFlags|| internally used for rendering.
|-
|UINT32 lPointer||Used internally as a pointer. If this value is 0, there is no entry for this object in the string stack (see below.) Any non-zero value means there is an entry for this object in the string stack.
|-
|UINT16 iInfo1||Unknown
|-
|UINT16 iZapHold||Unknown
|-
|}

At the present time it is assumed (perhaps hoped) that objects can be mapped to images in the same way as the tiles in the background layer can be mapped to images, but as yet there is no known way of doing this.

=== Savegame datas ===

Saved games in Jill are "snapshots" of the current level state, that's why some spare room exists in the map format to allow special data to be saved. The unsigned short integer is the level number (as displayed in the status screen). The second unsigned short integer is JILL's health. The next unsigned short integer is the amount of items displayed in the inventory. Each of the following 16 unsigned short integers represent an item in the inventory (note that used items such as keys are not removed from this stack, but items are rearranged to override the key value, according to the amount of items displayed in the inventory). Right after, the unsigned long integer stores the score. Then, there are 28 empty bytes to fill the block.

{|class="wikitable"
!InvItemNumber!!Description
|-
|0|| Morph: Jill
|-
|1|| Key: Red Key
|-
|2|| Weapon: Knive
|-
|3|| Key: Crystal Rock
|-
|4|| Morph: Frog
|-
|5|| Morph: Fire bird
|-
|6|| Bag of coins (?)
|-
|7|| Morph: Fish
|-
|8|| Weapon: Blade
|-
|9|| Bonus: High Jump
|-
|}

In Jill of the Jungle, this section is 70 bytes long. In Xargon it is 97 bytes long.

=== String stack ===

The Strings Stack is just a bunch of arbitrary strings (can be either text or file references). Each entry starts with an unsigned short integer defining the length of the incoming string. Note that the string is always followed by a null byte (so if "length of next entry" is 12, you only have the string size and should not forget to read an extra byte to reach the next entry). The string stack's entries are used for iType[20] ("write text"), 21 ("write text in big") and 12 ("checkpoints") and can contain music filenames, demo filenames, next level filenames or arbitrary text content.

In Xargon ans Jill, the checkpoint type contains a string:

* If the first character of this string is '*' then the rest of the string is taken to be the filename of the music file to play in that level.
* If the first character is '#' then the string is also a music file, but it is only played if there is no song currently playing, or the level number is between 1 and 32 inclusive. This is probably used for the main menu/credits/etc. so as not to interrupt the theme song when displaying those "levels", and it is used for the map level so the theme music keeps playing (rather than starting from the beginning again) when starting a game.
* The first character of the string can also be '&' which, in Xargon, forces the song to be <tt>song_33.xr1</tt> and in Jill does not change the song. The rest of the string as a macro filename, to be read and played back as a demo. This is used in the ending sequences.

== Object iTypes ==

Here's a list of objects used in Jill maps.

iXD and iYD defines both speed and direction of items and ennemies. Positive values goes to right and down while values under zero move the object left and up.
lPointer referes to a segment of memory and is likely used to store entries from the string stack, that's why the gap between two consecutive pointers equals 65536 (this is the maximum size in byte of a string in the stack)
Playable objects must be the first entry in the list to avoid a weird "scroll to first entity" bug in Jill

=== Functional ===

*iType[0] ''(PLAYER)'' Playable: Jill (level)
:ObjectInfo1 (sometimes '-1'): usage unknown
*iType[23] ''(TINY)'' Playable: Jill (map overview in Jill3)
*iType[54] ''(JILLFISH)'' Playable: Fish (never used in maps - if player dies, restart as Jill)
*iType[56] ''(JILLBIRD)'' Playable: Firebird (never used in maps - if player dies, restart as Jill)
*iType[57] ''(JILLFROG)'' Playable: Frog (never used in maps - if player dies, restart as Jill)
*iType[12] ''(CHECKPT)'' Trigger: Checkpoint
:iXD ('> 0'): X position of start in new map
:iYD ('> 0'): Y position of start in new map
:iState: If set to 1, the level is reset to it's initial state if player dies. If set to 0, the level's state is unchanged if player dies.
:iCounter ('>= 0'): checkpoint/level number
:iPointer: pointer
:'''NOTE:''' Always lock access to previous checkpoint when the player reaches a new checkpoint. This item reads an entry from the string stack: a single-character code and a filename. If the code is "*", it means "load and play this song from the beginning". If the code is "#", it means "keep on playing this song". If the code is "!", then there's no filename and it means "load previous map". If there's no code, then the filename is the next level to load.
*iType[15] ''(PAD)'' Trigger: Touch Trigger
:iCounter ('>= 0'): target tag
*iType[32] ''(SWITCH)'' Trigger: Switch
:iState (usually '0'): switch position, if target is off, set to '1'
:iXD (usually '0'): set to '0' when triggering two objects with different start states (one bridge 'off' and a wall 'on' for example)
*iType[52] ''(BUTTON)'' Trigger: Press Button
:iXD (set to '1' to face right, '-1' to face left): direction
:iState (set to '1' if target is off)
:iSubState: usage unknown, rarely used
:iCounter ('>= 0'): target tag
*iType[24] ''(DOOR)'' Misc: Locked Door
:iYD (usually '0', set to '1' for crystal): required key type
:iCounter ('>= 0'): self tag
*iType[25] ''(FALLDOOR)'' Misc: Collapsing ceiling
:iCounter ('>= 0'): self tag
*iType[26] ''(BRIDGER)'' Misc: Toggle Wall
:iXD (set to 1 for horizontal/floor)
:iYD (set to 1 for vertical/wall)
:iCounter ('>= 0'): self tag
:'''NOTE:''' If set as wall, must be placed on top of the wall, if set as floor, must be placed on the far left of the floor. By default, these walls are "off", use "ELEVMID" tiles for wall and "BRIDGE" for floor. Walls and bridges cannot go through two different types of tiles.
*iType[44] ''(KNIGHT)'' Misc: Knight
:iState (set to '1' for start on, '0' for start off): initial state
:iStateCount (set to '6' for 'none shall pass')
:iCounter ('>= 0'): self tag (toggle when triggered)
*iType[61] ''(ELEV)'' Misc: Lift
:iCounter (usually '0'): if set to '-1', do not return to initial state
:'''NOTE:''' When going up, the elevator will travel until the player hits a solid tile. When going down, the elevator will erase "ELEVMID" tiles, replacing them with the tile directly above. "ELEVBOT" tiles look the same as "ELEVMID" tiles, but an elevator will not travel through it.

=== Items & Bonus ===

*iType[1] ''(APPLE)'' Bonus: Apple
*iType[28] ''(TOKEN)'' Bonus: Pickup Item & morphing icons
:iCounter ('>= 0'): item type (can be anything from 0 to 9 and matches the inventory item number)
*iType[2] ''(KNIFE)'' Weapon: Knife
*iType[14] ''(KEY)'' Key: Old Red Key
*iType[33] ''(GEM)'' Key: Crystal
:iCounter (rarely set to '1'): usage unknown

=== Monsters ===

*iType[4] ''(BIGANT)'' Green bug
:iXD (usually '2'): movement speed
*iType[7] ''(DEMON)'' Devil
*iType[8] ''(BUNNY)'' Bunny
*iType[9] ''(INCHWORM)'' Worm
:iXD (usually '2'): movement speed
*iType[11] ''(BOBSLUG)'' Giant Slug
:iXD (usually '2'): movement speed
*iType[17] ''(FATSO)'' Lizard Man
:iXD (usually '2'): movement speed
*iType[22] ''(FROG)'' Frog
*iType[29] ''(ANT)'' Giant Ant
:iXD (usually '3'): movement speed
*iType[30] ''(PHOENIX)'' Phoenix
:iXD (usually '3'): movement speed
*iType[39] ''(SNAKE)'' Invincible Snake
:iXD (usually '2'): movement speed
*iType[43] ''(BAT)'' Giant Bat
*iType[45] ''(BEENEST)'' Hive
*iType[46] ''(BEESWARM)'' Bees
*iType[47] ''(CRAB)'' Crab
*iType[48] ''(CROC)'' Gator
:iXD (usually '2'): movement speed
*iType[53] ''(PAC)'' Ghost
:iXD (usually '2'): initial direction
:iCounter (usually '2'): movement speed
:'''NOTE:''' Ghosts move along the same tile type
*iType[59] ''(JELLYFISH)'' Jellyfish
*iType[60] ''(BADFISH)'' Eels

=== Traps ===

*iType[35] ''(BOULDER)'' Rolling Stone
*iType[38] ''(STALAG)'' Falling Spike
:iCounter ('>= 0'): self tag (fall when triggered)
*iType[41] ''(BOLL)'' Boucing Ball
:iCounter (usually '4'): ball type (0-small, 3-red, 4-green)
*iType[65] ''(VINECLIMB)'' Sparks
:iYD (usually '2'): movement speed
:'''NOTE:''' Sparks move along the same tile type

=== Misc ===

*iType[13] ''(PAUL)'' Misc: Prince
:iState (<code><nowiki>''</nowiki></code>): object animation frame
*iType[19] ''(CLOUD)'' Misc: Cloud
:iCounter ('>= 0'): usage unknown
:iXD (<code><nowiki>''</nowiki></code>): movement speed
*iType[20] ''(TEXT6)'' Misc: Write text (small capital letters)
:iXD (<code><nowiki>''</nowiki></code>): CGA color index number
:iYD (usually '-1' for transparent): background color
:lPointer: pointer
:'''NOTE:''' This item reads an entry from the string stack
*iType[21] ''(TEXT8)'' Misc: Write text (big letters)
:iXD (<code><nowiki>''</nowiki></code>): CGA color index number
:iYD (usually '-1' for transparent): background color
:lPointer: pointer
:'''NOTE:''' This item reads an entry from the string stack
*iType[40] ''(SEAROCK)'' Misc: Underwater Rock
*iType[42] ''(MEGA)'' Misc: Huge letter
:iXD ('>= 0'): letter type (0-M, 1-E, 2-G, 3-A, 4-S)
:iCounter ('>= 0'): self tag (fall when triggered)
*iType[49] ''(EPIC)'' Misc: Epic Logo
*iType[51] ''(SKULL)'' Misc: Big Skull
:iCounter ('>= 0'): self tag (laugh with red gloomy eyes when triggered)
*iType[64] ''(EYE)'' Misc: Eye
*iType[66] ''(FLAG)'' Misc: Flag
*iType[67] ''(MAPDEMO)'' Misc: "Demo"/"Map" sign
:iXD (sign type, '>= 0'): set to '1' for "map", '0' for "demo"

=== Untested ===

*iType[3] ? (buggy/unusable)
*iType[5] ? (buggy/unusable)
*iType[10] ? (buggy/unusable)
*iType[16] ? (buggy/unusable)
*iType[27] ? (buggy/unusable)
*iType[34] ? (buggy/unusable)
*iType[50] ? (buggy/unusable)
*iType[55] ? (buggy/unusable)
*iType[6] Buggy: harmless firebird
*iType[18] Saves: Demon attack
:iSpeedX (<code><nowiki>''</nowiki></code>): Horizontal speed
:iSpeedY (<code><nowiki>''</nowiki></code>): Vertical speed
*iType[31] Saves: flame attack
*iType[36] Saves: Particle
:iState (<code><nowiki>''</nowiki></code>): color
:iSpeedX (<code><nowiki>''</nowiki></code>): velocity X
:iSpeedY (<code><nowiki>''</nowiki></code>): velocity Y
:iFlag (<code><nowiki>'16384'</nowiki></code>): Unknow
:iCounter (<code><nowiki>''</nowiki></code>): Unknow
*iType[37] Saves: Pain effect
*iType[58] Saves: Bubbles
:iFlag (<code><nowiki>'16384'</nowiki></code>): Unknow
*iType[62] Saves: Player attack (fireball)
*iType[63] Saves: Player attack (fish)

== Credits ==

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

[[Category:Jill of the Jungle]]
[[Category:File Formats]]
[[Category:Map Files]]

Jill of the Jungle Map Format

2013-05-31T23:12:30Z

Jaguar: Added object names to Objects

{{Stub}}

The '''Jill of the Jungle map format''' is the format used to describe the levels played during the game. The maps contain two layers - a background layer and an "object" layer. The background layer is a grid of 16x16 pixel tiles, 128 tiles wide and 64 tiles high. The object layer is made up of an arbitrary list of objects, with X and Y offsets in pixels.

== File format ==

The main map file starts off with the background layer, then immediately following it is the foreground layer, the savegame data block and the string stack.

=== Background layer ===

The background layer is quite simple. It is an array of 8,192 16-bit values (128 tiles wide by 64 tiles high == 8192 tiles total.) Each 16-bit value is a code, such as 0xC0D3. The formula ((x * MAP_HEIGHT) + y) * 2 (where MAP_HEIGHT is 64) will provide the offset (in bytes) into the map file where that grid's 16-bit code is located.

Once the code is found, its lower three nybbles are isolated (e.g. code & 0xFFF) which provides an ID that is listed in the tile mapping table (see below.) The tile mapping table then provides an index into the graphics file for the image that should be displayed at that grid location.

For example, if the 16-bit code is 0xC0D3, then isolating the lower three nybbles will provide the number 0x00D3. At the entry for ID 0x00D3 in the tile mapping table, the value might be iTileset as 0x12 and iTile as 0x34. This means that in the graphics file, tileset number 0x12 should be accessed, and tile number 0x34 within that tileset should be drawn at the grid coordinate.

It is also important to note that these values are stored little-endian, like the [[SHA Format|SHA format]]. This means that for example the value 0xC0D3 is stored as the two bytes D3-C0, not as C0-D3.

==== Tile mapping table ====

There is a separate file in the game directory that contains mappings between tile codes in the background layer and the game's graphics. In [[Jill of the Jungle]] this is called <tt>JILL.DMA</tt> and in [[Xargon]] it is <tt>TILES.XRx</tt>.

This file is arranged as an array of entries, one after the other. Each entry is in the following format:

{|class="wikitable"
!Data type!!Description
|-
| [[UINT16LE]] iMapCode || ID used in map file
|-
| [[UINT8]] iTile || Index into the tileset for the image to use
|-
| [[UINT8]] iTileset || Index of tileset containing this tile's image (ignore upper two bits - see below)
|-
| [[UINT16LE]] iFlags || Flags for this tile (can stand on, can hurt player, etc.)
|-
| [[UINT8]] iLength || Length of tile name
|-
| [[char]] cName[iLength] || <tt>iLength</tt> characters for the tile name. This string is not NULL-terminated.
|}

Note that only the lower six bits of <tt>iTileset</tt> refer to the tile number. The purpose of the upper unknown bits is unknown. To get a valid tileset index use <code>iTileset & 0x3F</code>.

<tt>iFlags</tt> is broken up as follows:

{|class="wikitable"
!Bit!!Hex!!Name!!Description
|-
||-||0x0000||<zero>||Default solid block
|-
|1||0x0001||F_PLAYERTHRU||Blocks you can walk, jump or fall through (background tiles, the path on the overhead map, etc.)
|-
|2||0x0002||F_STAIR, F_NOTSTAIR (Xargon)||Blocks that you can stand on (can also jump up through when combined with F_PLAYERTHRU)
|-
|3||0x0004||F_VINE, F_NOTVINE (Xargon)||Can climb this block - usually combined with F_PLAYERTHRU (giving 0x0005)
|-
|4||0x0008||F_MSGTOUCH||Activates game-specific code when touched
|-
|5||0x0010||F_MSGDRAW|| Regular blocks have just one shape, f_msgdraw triggers <tt>msg_block(msg_draw)</tt> for animated blocks.
|-
|6||0x0020||F_MSGUPDATE|| game-specific code (through <tt>msg_block(msg_update)</tt>) at every frame. For animated blocks.
|-
|7||0x0040||F_INSIDE||This block contains text inside it
|-
|8||0x0080||F_FRONT|| object property : Foreground object
|-
|9||0x0100||F_TRIGGER||Unknown
|-
|10||0x0200||F_BACK || object property: Background object (e.g. torches)
|-
|10||0x0200||F_TINYTHRU|| (likely PlayerThru when player is in 'mini' mode, unused in Xargon)
|-
|11||0x0400||F_ALWAYS|| object property : "Always updates object"
|-
|12||0x0800||F_KILLABLE|| object property : monster can be killed with regular weapon.
|-
|13||0x1000||F_FIREBALL|| object property : object is a fireball
|-
|14||0x2000||F_WATER|| A water tile. regular player will sink, the S.U.B. and aquatic monster can swim through it, but not out of it
|-
|14||0x4000||F_NOT_WATER|| (Xargon) Not a water tile.
|-
|15||0x4000||F_WEAPON|| object property : object is a regular weapon
|-
|16||0x8000||(unused)||(unused)
|}

Note that the same "flag set" is used for both blocks and objects. Some properties only apply to blocks, some only apply to objects, some to both (<tt>f_msgtouch</tt>), and some flags have a different meaning for blocks and tile (e.g. 0x200 and 0x2000).

=== Object layer ===

The object layer is drawn in front of the background layer, and contains all the interactive elements of the map, such as points and enemies.

The object data starts straight after the background layer data, so that's at offset 16,384 bytes into the map file (8,192 tiles * two bytes per tile.) The first two bytes in the object layer are a 16-bit integer ([[UINT16LE]]) that stores the number of objects in the map, and this is followed by the data for each object, one after the other.

Each object is 31 bytes long, and is stored in the following structure:

{|class="wikitable"
!Data type!!Description
|-
|UINT8 iType||Object type (e.g. a "point item", or an enemy.)
|-
|UINT16 iX||X-coordinate of object
|-
|UINT16 iY||Y-coordinate of object
|-
|UINT16 iXD|| object horizontal speed
|-
|UINT16 iYD|| object vertical speed
|-
|UINT16 iWidth||Width of object
|-
|UINT16 iHeight||Height of object
|-
|UINT16 iState||Object sub-type (e.g. what type of "point item"), or current "State" (running, jumping, etc)
|-
|UINT16 iSubState||object-specific semantic
|-
|UINT16 iStateCount||object-specific semantic, typically a frame counter
|-
|UINT16 iCounter||Various uses. Often used to link doors or switches to obstacles.
|-
|UINT16 iFlags|| internally used for rendering.
|-
|UINT32 lPointer||Used internally as a pointer. If this value is 0, there is no entry for this object in the string stack (see below.) Any non-zero value means there is an entry for this object in the string stack.
|-
|UINT16 iInfo1||Unknown
|-
|UINT16 iZapHold||Unknown
|-
|}

At the present time it is assumed (perhaps hoped) that objects can be mapped to images in the same way as the tiles in the background layer can be mapped to images, but as yet there is no known way of doing this.

=== Savegame datas ===

Saved games in Jill are "snapshots" of the current level state, that's why some spare room exists in the map format to allow special data to be saved. The unsigned short integer is the level number (as displayed in the status screen). The second unsigned short integer is JILL's health. The next unsigned short integer is the amount of items displayed in the inventory. Each of the following 16 unsigned short integers represent an item in the inventory (note that used items such as keys are not removed from this stack, but items are rearranged to override the key value, according to the amount of items displayed in the inventory). Right after, the unsigned long integer stores the score. Then, there are 28 empty bytes to fill the block.

{|class="wikitable"
!InvItemNumber!!Description
|-
|0|| Morph: Jill
|-
|1|| Key: Red Key
|-
|2|| Weapon: Knive
|-
|3|| Key: Crystal Rock
|-
|4|| Morph: Frog
|-
|5|| Morph: Fire bird
|-
|6|| Bag of coins (?)
|-
|7|| Morph: Fish
|-
|8|| Weapon: Blade
|-
|9|| Bonus: High Jump
|-
|}

In Jill of the Jungle, this section is 70 bytes long. In Xargon it is 97 bytes long.

=== String stack ===

The Strings Stack is just a bunch of arbitrary strings (can be either text or file references). Each entry starts with an unsigned short integer defining the length of the incoming string. Note that the string is always followed by a null byte (so if "length of next entry" is 12, you only have the string size and should not forget to read an extra byte to reach the next entry). The string stack's entries are used for iType[20] ("write text"), 21 ("write text in big") and 12 ("checkpoints") and can contain music filenames, demo filenames, next level filenames or arbitrary text content.

In Xargon ans Jill, the checkpoint type contains a string:

* If the first character of this string is '*' then the rest of the string is taken to be the filename of the music file to play in that level.
* If the first character is '#' then the string is also a music file, but it is only played if there is no song currently playing, or the level number is between 1 and 32 inclusive. This is probably used for the main menu/credits/etc. so as not to interrupt the theme song when displaying those "levels", and it is used for the map level so the theme music keeps playing (rather than starting from the beginning again) when starting a game.
* The first character of the string can also be '&' which, in Xargon, forces the song to be <tt>song_33.xr1</tt> and in Jill does not change the song. The rest of the string as a macro filename, to be read and played back as a demo. This is used in the ending sequences.

== Object iTypes ==

Here's a list of objects used in Jill maps.

iXD and iYD defines both speed and direction of items and ennemies. Positive values goes to right and down while values under zero move the object left and up.
lPointer referes to a segment of memory and is likely used to store entries from the string stack, that's why the gap between two consecutive pointers equals 65536 (this is the maximum size in byte of a string in the stack)
Playable objects must be the first entry in the list to avoid a weird "scroll to first entity" bug in Jill

=== Functional ===

*iType[0] ''(PLAYER)'' Playable: Jill (level)
:ObjectInfo1 (sometimes '-1'): usage unknown
*iType[23] ''(TINY)'' Playable: Jill (map overview in Jill3)
*iType[54] ''(JILLFISH)'' Playable: Fish (never used in maps - if player dies, restart as Jill)
*iType[56] ''(JILLBIRD)'' Playable: Firebird (never used in maps - if player dies, restart as Jill)
*iType[57] ''(JILLFROG)'' Playable: Frog (never used in maps - if player dies, restart as Jill)
*iType[12] ''(CHECKPT)'' Trigger: Checkpoint
:iXD ('> 0'): X position of start in new map
:iYD ('> 0'): Y position of start in new map
:iState: If set to 1, the level is reset to it's initial state if player dies. If set to 0, the level's state is unchanged if player dies.
:iCounter ('>= 0'): checkpoint/level number
:iPointer: pointer
:'''NOTE:''' Always lock access to previous checkpoint when the player reaches a new checkpoint. This item reads an entry from the string stack: a single-character code and a filename. If the code is "*", it means "load and play this song from the beginning". If the code is "#", it means "keep on playing this song". If the code is "!", then there's no filename and it means "load previous map". If there's no code, then the filename is the next level to load.
*iType[15] ''(PAD)'' Trigger: Touch Trigger
:iCounter ('>= 0'): target tag
*iType[32] ''(SWITCH)'' Trigger: Switch
:iState (usually '0'): switch position, if target is off, set to '1'
:iXD (usually '0'): set to '0' when triggering two objects with different start states (one bridge 'off' and a wall 'on' for example)
*iType[52] ''(BUTTON)'' Trigger: Press Button
:iXD (set to '1' to face right, '-1' to face left): direction
:iState (set to '1' if target is off)
:iSubState: usage unknown, rarely used
:iCounter ('>= 0'): target tag
*iType[24] ''(DOOR)'' Misc: Locked Door
:iYD (usually '0', set to '1' for crystal): required key type
:iCounter ('>= 0'): self tag
*iType[25] ''(FALLDOOR)'' Misc: Collapsing ceiling
:iCounter ('>= 0'): self tag
*iType[26] ''(BRIDGER)'' Misc: Toggle Wall
:iXD (set to 1 for horizontal/floor)
:iYD (set to 1 for vertical/wall)
:iCounter ('>= 0'): self tag
:'''NOTE:''' If set as wall, must be placed on top of the wall, if set as floor, must be placed on the far left of the floor. By default, these walls are "off", use "ELEVMID" tiles for wall and "BRIDGE" for floor. Walls and bridges cannot go through two different types of tiles.
*iType[44] ''(KNIGHT)'' Misc: Knight
:iState (set to '1' for start on, '0' for start off): initial state
:iStateCount (set to '6' for 'none shall pass')
:iCounter ('>= 0'): self tag (toggle when triggered)
*iType[61] ''(ELEV)'' Misc: Lift
:iCounter (usually '0'): if set to '-1', do not return to initial state
:'''NOTE:''' When going up, the elevator will travel until the player hits a solid tile. When going down, the elevator will erase "ELEVMID" tiles, replacing them with the tile directly above. "ELEVBOT" tiles look the same as "ELEVMID" tiles, but an elevator will not travel through it.

=== Items & Bonus ===

*iType[1] ''(APPLE)'' Bonus: Apple
*iType[28] ''(TOKEN)'' Bonus: Pickup Item & morphing icons
:iCounter ('>= 0'): item type (can be anything from 0 to 9 and matches the inventory item number)
*iType[2] ''(KNIFE)'' Weapon: Knive
*iType[14] ''(KEY)'' Key: Old Red Key
*iType[33] ''(GEM)'' Key: Crystal
:iCounter (rarely set to '1'): usage unknown

=== Monsters ===

*iType[4] ''(BIGANT)'' Green bug
:iXD (usually '2'): movement speed
*iType[7] ''(DEMON)'' Devil
*iType[8] ''(BUNNY)'' Bunny
*iType[9] ''(INCHWORM)'' Worm
:iXD (usually '2'): movement speed
*iType[11] ''(BOBSLUG)'' Giant Slug
:iXD (usually '2'): movement speed
*iType[17] ''(FATSO)'' Lizard Man
:iXD (usually '2'): movement speed
*iType[22] ''(FROG)'' Frog
*iType[29] ''(ANT)'' Giant Ant
:iXD (usually '3'): movement speed
*iType[30] ''(PHOENIX)'' Phoenix
:iXD (usually '3'): movement speed
*iType[39] ''(SNAKE)'' Invincible Snake
:iXD (usually '2'): movement speed
*iType[43] ''(BAT)'' Giant Bat
*iType[45] ''(BEENEST)'' Hive
*iType[46] ''(BEESWARM)'' Bees
*iType[47] ''(CRAB)'' Crab
*iType[48] ''(CROC)'' Gator
:iXD (usually '2'): movement speed
*iType[53] ''(PAC)'' Ghost
:iXD (usually '2'): initial direction
:iCounter (usually '2'): movement speed
:'''NOTE:''' Ghosts move along the same tile type
*iType[59] ''(JELLYFISH)'' Jellyfish
*iType[60] ''(BADFISH)'' Eels

=== Traps ===

*iType[35] ''(BOULDER)'' Rolling Stone
*iType[38] ''(STALAG)'' Falling Spike
:iCounter ('>= 0'): self tag (fall when triggered)
*iType[41] ''(BOLL)'' Boucing Ball
:iCounter (usually '4'): ball type (0-small, 3-red, 4-green)
*iType[65] ''(VINECLIMB)'' Sparks
:iYD (usually '2'): movement speed
:'''NOTE:''' Sparks move along the same tile type

=== Misc ===

*iType[13] ''(PAUL)'' Misc: Prince
:iState (<code><nowiki>''</nowiki></code>): object animation frame
*iType[19] ''(CLOUD)'' Misc: Cloud
:iCounter ('>= 0'): usage unknown
:iXD (<code><nowiki>''</nowiki></code>): movement speed
*iType[20] ''(TEXT6)'' Misc: Write text (small capital letters)
:iXD (<code><nowiki>''</nowiki></code>): CGA color index number
:iYD (usually '-1' for transparent): background color
:lPointer: pointer
:'''NOTE:''' This item reads an entry from the string stack
*iType[21] ''(TEXT8)'' Misc: Write text (big letters)
:iXD (<code><nowiki>''</nowiki></code>): CGA color index number
:iYD (usually '-1' for transparent): background color
:lPointer: pointer
:'''NOTE:''' This item reads an entry from the string stack
*iType[40] ''(SEAROCK)'' Misc: Underwater Rock
*iType[42] ''(MEGA)'' Misc: Huge letter
:iXD ('>= 0'): letter type (0-M, 1-E, 2-G, 3-A, 4-S)
:iCounter ('>= 0'): self tag (fall when triggered)
*iType[49] ''(EPIC)'' Misc: Epic Logo
*iType[51] ''(SKULL)'' Misc: Big Skull
:iCounter ('>= 0'): self tag (laugh with red gloomy eyes when triggered)
*iType[64] ''(EYE)'' Misc: Eye
*iType[66] ''(FLAG)'' Misc: Flag
*iType[67] ''(MAPDEMO)'' Misc: "Demo"/"Map" sign
:iXD (sign type, '>= 0'): set to '1' for "map", '0' for "demo"

=== Untested ===

*iType[3] ? (buggy/unusable)
*iType[5] ? (buggy/unusable)
*iType[10] ? (buggy/unusable)
*iType[16] ? (buggy/unusable)
*iType[27] ? (buggy/unusable)
*iType[34] ? (buggy/unusable)
*iType[50] ? (buggy/unusable)
*iType[55] ? (buggy/unusable)
*iType[6] Buggy: harmless firebird
*iType[18] Saves: Demon attack
:iSpeedX (<code><nowiki>''</nowiki></code>): Horizontal speed
:iSpeedY (<code><nowiki>''</nowiki></code>): Vertical speed
*iType[31] Saves: flame attack
*iType[36] Saves: Particle
:iState (<code><nowiki>''</nowiki></code>): color
:iSpeedX (<code><nowiki>''</nowiki></code>): velocity X
:iSpeedY (<code><nowiki>''</nowiki></code>): velocity Y
:iFlag (<code><nowiki>'16384'</nowiki></code>): Unknow
:iCounter (<code><nowiki>''</nowiki></code>): Unknow
*iType[37] Saves: Pain effect
*iType[58] Saves: Bubbles
:iFlag (<code><nowiki>'16384'</nowiki></code>): Unknow
*iType[62] Saves: Player attack (fireball)
*iType[63] Saves: Player attack (fish)

== Credits ==

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

[[Category:Jill of the Jungle]]
[[Category:File Formats]]
[[Category:Map Files]]

Jill of the Jungle Map Format

2013-05-31T22:25:02Z

Jaguar: /* Functional */ Added extra info for Checkpoint type and Elevator

{{Stub}}

The '''Jill of the Jungle map format''' is the format used to describe the levels played during the game. The maps contain two layers - a background layer and an "object" layer. The background layer is a grid of 16x16 pixel tiles, 128 tiles wide and 64 tiles high. The object layer is made up of an arbitrary list of objects, with X and Y offsets in pixels.

== File format ==

The main map file starts off with the background layer, then immediately following it is the foreground layer, the savegame data block and the string stack.

=== Background layer ===

The background layer is quite simple. It is an array of 8,192 16-bit values (128 tiles wide by 64 tiles high == 8192 tiles total.) Each 16-bit value is a code, such as 0xC0D3. The formula ((x * MAP_HEIGHT) + y) * 2 (where MAP_HEIGHT is 64) will provide the offset (in bytes) into the map file where that grid's 16-bit code is located.

Once the code is found, its lower three nybbles are isolated (e.g. code & 0xFFF) which provides an ID that is listed in the tile mapping table (see below.) The tile mapping table then provides an index into the graphics file for the image that should be displayed at that grid location.

For example, if the 16-bit code is 0xC0D3, then isolating the lower three nybbles will provide the number 0x00D3. At the entry for ID 0x00D3 in the tile mapping table, the value might be iTileset as 0x12 and iTile as 0x34. This means that in the graphics file, tileset number 0x12 should be accessed, and tile number 0x34 within that tileset should be drawn at the grid coordinate.

It is also important to note that these values are stored little-endian, like the [[SHA Format|SHA format]]. This means that for example the value 0xC0D3 is stored as the two bytes D3-C0, not as C0-D3.

==== Tile mapping table ====

There is a separate file in the game directory that contains mappings between tile codes in the background layer and the game's graphics. In [[Jill of the Jungle]] this is called <tt>JILL.DMA</tt> and in [[Xargon]] it is <tt>TILES.XRx</tt>.

This file is arranged as an array of entries, one after the other. Each entry is in the following format:

{|class="wikitable"
!Data type!!Description
|-
| [[UINT16LE]] iMapCode || ID used in map file
|-
| [[UINT8]] iTile || Index into the tileset for the image to use
|-
| [[UINT8]] iTileset || Index of tileset containing this tile's image (ignore upper two bits - see below)
|-
| [[UINT16LE]] iFlags || Flags for this tile (can stand on, can hurt player, etc.)
|-
| [[UINT8]] iLength || Length of tile name
|-
| [[char]] cName[iLength] || <tt>iLength</tt> characters for the tile name. This string is not NULL-terminated.
|}

Note that only the lower six bits of <tt>iTileset</tt> refer to the tile number. The purpose of the upper unknown bits is unknown. To get a valid tileset index use <code>iTileset & 0x3F</code>.

<tt>iFlags</tt> is broken up as follows:

{|class="wikitable"
!Bit!!Hex!!Name!!Description
|-
||-||0x0000||<zero>||Default solid block
|-
|1||0x0001||F_PLAYERTHRU||Blocks you can walk, jump or fall through (background tiles, the path on the overhead map, etc.)
|-
|2||0x0002||F_STAIR, F_NOTSTAIR (Xargon)||Blocks that you can stand on (can also jump up through when combined with F_PLAYERTHRU)
|-
|3||0x0004||F_VINE, F_NOTVINE (Xargon)||Can climb this block - usually combined with F_PLAYERTHRU (giving 0x0005)
|-
|4||0x0008||F_MSGTOUCH||Activates game-specific code when touched
|-
|5||0x0010||F_MSGDRAW|| Regular blocks have just one shape, f_msgdraw triggers <tt>msg_block(msg_draw)</tt> for animated blocks.
|-
|6||0x0020||F_MSGUPDATE|| game-specific code (through <tt>msg_block(msg_update)</tt>) at every frame. For animated blocks.
|-
|7||0x0040||F_INSIDE||This block contains text inside it
|-
|8||0x0080||F_FRONT|| object property : Foreground object
|-
|9||0x0100||F_TRIGGER||Unknown
|-
|10||0x0200||F_BACK || object property: Background object (e.g. torches)
|-
|10||0x0200||F_TINYTHRU|| (likely PlayerThru when player is in 'mini' mode, unused in Xargon)
|-
|11||0x0400||F_ALWAYS|| object property : "Always updates object"
|-
|12||0x0800||F_KILLABLE|| object property : monster can be killed with regular weapon.
|-
|13||0x1000||F_FIREBALL|| object property : object is a fireball
|-
|14||0x2000||F_WATER|| A water tile. regular player will sink, the S.U.B. and aquatic monster can swim through it, but not out of it
|-
|14||0x4000||F_NOT_WATER|| (Xargon) Not a water tile.
|-
|15||0x4000||F_WEAPON|| object property : object is a regular weapon
|-
|16||0x8000||(unused)||(unused)
|}

Note that the same "flag set" is used for both blocks and objects. Some properties only apply to blocks, some only apply to objects, some to both (<tt>f_msgtouch</tt>), and some flags have a different meaning for blocks and tile (e.g. 0x200 and 0x2000).

=== Object layer ===

The object layer is drawn in front of the background layer, and contains all the interactive elements of the map, such as points and enemies.

The object data starts straight after the background layer data, so that's at offset 16,384 bytes into the map file (8,192 tiles * two bytes per tile.) The first two bytes in the object layer are a 16-bit integer ([[UINT16LE]]) that stores the number of objects in the map, and this is followed by the data for each object, one after the other.

Each object is 31 bytes long, and is stored in the following structure:

{|class="wikitable"
!Data type!!Description
|-
|UINT8 iType||Object type (e.g. a "point item", or an enemy.)
|-
|UINT16 iX||X-coordinate of object
|-
|UINT16 iY||Y-coordinate of object
|-
|UINT16 iXD|| object horizontal speed
|-
|UINT16 iYD|| object vertical speed
|-
|UINT16 iWidth||Width of object
|-
|UINT16 iHeight||Height of object
|-
|UINT16 iState||Object sub-type (e.g. what type of "point item"), or current "State" (running, jumping, etc)
|-
|UINT16 iSubState||object-specific semantic
|-
|UINT16 iStateCount||object-specific semantic, typically a frame counter
|-
|UINT16 iCounter||Various uses. Often used to link doors or switches to obstacles.
|-
|UINT16 iFlags|| internally used for rendering.
|-
|UINT32 lPointer||Used internally as a pointer. If this value is 0, there is no entry for this object in the string stack (see below.) Any non-zero value means there is an entry for this object in the string stack.
|-
|UINT16 iInfo1||Unknown
|-
|UINT16 iZapHold||Unknown
|-
|}

At the present time it is assumed (perhaps hoped) that objects can be mapped to images in the same way as the tiles in the background layer can be mapped to images, but as yet there is no known way of doing this.

=== Savegame datas ===

Saved games in Jill are "snapshots" of the current level state, that's why some spare room exists in the map format to allow special data to be saved. The unsigned short integer is the level number (as displayed in the status screen). The second unsigned short integer is JILL's health. The next unsigned short integer is the amount of items displayed in the inventory. Each of the following 16 unsigned short integers represent an item in the inventory (note that used items such as keys are not removed from this stack, but items are rearranged to override the key value, according to the amount of items displayed in the inventory). Right after, the unsigned long integer stores the score. Then, there are 28 empty bytes to fill the block.

{|class="wikitable"
!InvItemNumber!!Description
|-
|0|| Morph: Jill
|-
|1|| Key: Red Key
|-
|2|| Weapon: Knive
|-
|3|| Key: Crystal Rock
|-
|4|| Morph: Frog
|-
|5|| Morph: Fire bird
|-
|6|| Bag of coins (?)
|-
|7|| Morph: Fish
|-
|8|| Weapon: Blade
|-
|9|| Bonus: High Jump
|-
|}

In Jill of the Jungle, this section is 70 bytes long. In Xargon it is 97 bytes long.

=== String stack ===

The Strings Stack is just a bunch of arbitrary strings (can be either text or file references). Each entry starts with an unsigned short integer defining the length of the incoming string. Note that the string is always followed by a null byte (so if "length of next entry" is 12, you only have the string size and should not forget to read an extra byte to reach the next entry). The string stack's entries are used for iType[20] ("write text"), 21 ("write text in big") and 12 ("checkpoints") and can contain music filenames, demo filenames, next level filenames or arbitrary text content.

In Xargon ans Jill, the checkpoint type contains a string:

* If the first character of this string is '*' then the rest of the string is taken to be the filename of the music file to play in that level.
* If the first character is '#' then the string is also a music file, but it is only played if there is no song currently playing, or the level number is between 1 and 32 inclusive. This is probably used for the main menu/credits/etc. so as not to interrupt the theme song when displaying those "levels", and it is used for the map level so the theme music keeps playing (rather than starting from the beginning again) when starting a game.
* The first character of the string can also be '&' which, in Xargon, forces the song to be <tt>song_33.xr1</tt> and in Jill does not change the song. The rest of the string as a macro filename, to be read and played back as a demo. This is used in the ending sequences.

== Object iTypes ==

Here's a list of objects used in Jill maps.

iXD and iYD defines both speed and direction of items and ennemies. Positive values goes to right and down while values under zero move the object left and up.
lPointer referes to a segment of memory and is likely used to store entries from the string stack, that's why the gap between two consecutive pointers equals 65536 (this is the maximum size in byte of a string in the stack)
Playable objects must be the first entry in the list to avoid a weird "scroll to first entity" bug in Jill

=== Functional ===

*iType[0] Playable: Jill (level)
:ObjectInfo1 (sometimes '-1'): usage unknown
*iType[23] Playable: Jill (map overview in Jill3)
*iType[54] Playable: Fish (never used in maps - if player dies, restart as Jill)
*iType[56] Playable: Firebird (never used in maps - if player dies, restart as Jill)
*iType[57] Playable: Frog (never used in maps - if player dies, restart as Jill)
*iType[12] Trigger: Checkpoint
:iXD ('> 0'): X position of start in new map
:iYD ('> 0'): Y position of start in new map
:iState: If set to 1, the level is reset to it's initial state if player dies. If set to 0, the level's state is unchanged if player dies.
:iCounter ('>= 0'): checkpoint/level number
:iPointer: pointer
:'''NOTE:''' Always lock access to previous checkpoint when the player reaches a new checkpoint. This item reads an entry from the string stack: a single-character code and a filename. If the code is "*", it means "load and play this song from the beginning". If the code is "#", it means "keep on playing this song". If the code is "!", then there's no filename and it means "load previous map". If there's no code, then the filename is the next level to load.
*iType[15] Trigger: Touch Trigger
:iCounter ('>= 0'): target tag
*iType[32] Trigger: Switch
:iState (usually '0'): switch position, if target is off, set to '1'
:iXD (usually '0'): set to '0' when triggering two objects with different start states (one bridge 'off' and a wall 'on' for example)
*iType[52] Trigger: Press Button
:iXD (set to '1' to face right, '-1' to face left): direction
:iState (set to '1' if target is off)
:iSubState: usage unknown, rarely used
:iCounter ('>= 0'): target tag
*iType[24] Misc: Locked Door
:iYD (usually '0', set to '1' for crystal): required key type
:iCounter ('>= 0'): self tag
*iType[25] Misc: Collapsing ceiling
:iCounter ('>= 0'): self tag
*iType[26] Misc: Toggle Wall
:iXD (set to 1 for horizontal/floor)
:iYD (set to 1 for vertical/wall)
:iCounter ('>= 0'): self tag
:'''NOTE:''' If set as wall, must be placed on top of the wall, if set as floor, must be placed on the far left of the floor. By default, these walls are "off", use "ELEVMID" tiles for wall and "BRIDGE" for floor. Walls and bridges cannot go through two different types of tiles.
*iType[44] Misc: Knight
:iState (set to '1' for start on, '0' for start off): initial state
:iStateCount (set to '6' for 'none shall pass')
:iCounter ('>= 0'): self tag (toggle when triggered)
*iType[61] Misc: Lift
:iCounter (usually '0'): if set to '-1', do not return to initial state
:'''NOTE:''' When going up, the elevator will travel until the player hits a solid tile. When going down, the elevator will erase "ELEVMID" tiles, replacing them with the tile directly above. "ELEVBOT" tiles look the same as "ELEVMID" tiles, but an elevator will not travel through it.

=== Items & Bonus ===

*iType[1] Bonus: Apple
*iType[28] Bonus: Pickup Item & morphing icons
:iCounter ('>= 0'): item type (can be anything from 0 to 9 and matches the inventory item number)
*iType[2] Weapon: Knive
*iType[14] Key: Old Red Key
*iType[33] Key: Crystal
:iCounter (rarely set to '1'): usage unknown

=== Monsters ===

*iType[4] Green bug
:iXD (usually '2'): movement speed
*iType[7] Devil
*iType[8] Bunny
*iType[9] Worm
:iXD (usually '2'): movement speed
*iType[11] Giant Slug
:iXD (usually '2'): movement speed
*iType[17] Lizard Man
:iXD (usually '2'): movement speed
*iType[22] Frog
*iType[29] Giant Ant
:iXD (usually '3'): movement speed
*iType[30] Phoenix
:iXD (usually '3'): movement speed
*iType[39] Invincible Snake
:iXD (usually '2'): movement speed
*iType[43] Giant Bat
*iType[45] Hive
*iType[46] Bees
*iType[47] Crab
*iType[48] Gator
:iXD (usually '2'): movement speed
*iType[53] Ghost
:iXD (usually '2'): initial direction
:iCounter (usually '2'): movement speed
:'''NOTE:''' Ghosts move along the same tile type
*iType[59] Jellyfish
*iType[60] Eels

=== Traps ===

*iType[35] Rolling Stone
*iType[38] Falling Spike
:iCounter ('>= 0'): self tag (fall when triggered)
*iType[41] Boucing Ball
:iCounter (usually '4'): ball type (0-small, 3-red, 4-green)
*iType[65] Sparks
:iYD (usually '2'): movement speed
:'''NOTE:''' Sparks move along the same tile type

=== Misc ===

*iType[13] Misc: Prince
:iState (<code><nowiki>''</nowiki></code>): object animation frame
*iType[19] Misc: Cloud
:iCounter ('>= 0'): usage unknown
:iXD (<code><nowiki>''</nowiki></code>): movement speed
*iType[20] Misc: Write text (small capital letters)
:iXD (<code><nowiki>''</nowiki></code>): CGA color index number
:iYD (usually '-1' for transparent): background color
:lPointer: pointer
:'''NOTE:''' This item reads an entry from the string stack
*iType[21] Misc: Write text (big letters)
:iXD (<code><nowiki>''</nowiki></code>): CGA color index number
:iYD (usually '-1' for transparent): background color
:lPointer: pointer
:'''NOTE:''' This item reads an entry from the string stack
*iType[40] Misc: Underwater Rock
*iType[42] Misc: Huge letter
:iXD ('>= 0'): letter type (0-M, 1-E, 2-G, 3-A, 4-S)
:iCounter ('>= 0'): self tag (fall when triggered)
*iType[49] Misc: Epic Logo
*iType[51] Misc: Big Skull
:iCounter ('>= 0'): self tag (laugh with red gloomy eyes when triggered)
*iType[64] Misc: Eye
*iType[66] Misc: Flag
*iType[67] Misc: "Demo"/"Map" sign
:iXD (sign type, '>= 0'): set to '1' for "map", '0' for "demo"

=== Untested ===

*iType[3] ? (buggy/unusable)
*iType[5] ? (buggy/unusable)
*iType[10] ? (buggy/unusable)
*iType[16] ? (buggy/unusable)
*iType[27] ? (buggy/unusable)
*iType[34] ? (buggy/unusable)
*iType[50] ? (buggy/unusable)
*iType[55] ? (buggy/unusable)
*iType[6] Buggy: harmless firebird
*iType[18] Saves: Demon attack
:iSpeedX (<code><nowiki>''</nowiki></code>): Horizontal speed
:iSpeedY (<code><nowiki>''</nowiki></code>): Vertical speed
*iType[31] Saves: flame attack
*iType[36] Saves: Particle
:iState (<code><nowiki>''</nowiki></code>): color
:iSpeedX (<code><nowiki>''</nowiki></code>): velocity X
:iSpeedY (<code><nowiki>''</nowiki></code>): velocity Y
:iFlag (<code><nowiki>'16384'</nowiki></code>): Unknow
:iCounter (<code><nowiki>''</nowiki></code>): Unknow
*iType[37] Saves: Pain effect
*iType[58] Saves: Bubbles
:iFlag (<code><nowiki>'16384'</nowiki></code>): Unknow
*iType[62] Saves: Player attack (fireball)
*iType[63] Saves: Player attack (fish)

== Credits ==

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

[[Category:Jill of the Jungle]]
[[Category:File Formats]]
[[Category:Map Files]]

Jill of the Jungle Map Format

2013-05-31T21:59:25Z

Jaguar: /* String stack */ Updated to include matching data for Jill

{{Stub}}

The '''Jill of the Jungle map format''' is the format used to describe the levels played during the game. The maps contain two layers - a background layer and an "object" layer. The background layer is a grid of 16x16 pixel tiles, 128 tiles wide and 64 tiles high. The object layer is made up of an arbitrary list of objects, with X and Y offsets in pixels.

== File format ==

The main map file starts off with the background layer, then immediately following it is the foreground layer, the savegame data block and the string stack.

=== Background layer ===

The background layer is quite simple. It is an array of 8,192 16-bit values (128 tiles wide by 64 tiles high == 8192 tiles total.) Each 16-bit value is a code, such as 0xC0D3. The formula ((x * MAP_HEIGHT) + y) * 2 (where MAP_HEIGHT is 64) will provide the offset (in bytes) into the map file where that grid's 16-bit code is located.

Once the code is found, its lower three nybbles are isolated (e.g. code & 0xFFF) which provides an ID that is listed in the tile mapping table (see below.) The tile mapping table then provides an index into the graphics file for the image that should be displayed at that grid location.

For example, if the 16-bit code is 0xC0D3, then isolating the lower three nybbles will provide the number 0x00D3. At the entry for ID 0x00D3 in the tile mapping table, the value might be iTileset as 0x12 and iTile as 0x34. This means that in the graphics file, tileset number 0x12 should be accessed, and tile number 0x34 within that tileset should be drawn at the grid coordinate.

It is also important to note that these values are stored little-endian, like the [[SHA Format|SHA format]]. This means that for example the value 0xC0D3 is stored as the two bytes D3-C0, not as C0-D3.

==== Tile mapping table ====

There is a separate file in the game directory that contains mappings between tile codes in the background layer and the game's graphics. In [[Jill of the Jungle]] this is called <tt>JILL.DMA</tt> and in [[Xargon]] it is <tt>TILES.XRx</tt>.

This file is arranged as an array of entries, one after the other. Each entry is in the following format:

{|class="wikitable"
!Data type!!Description
|-
| [[UINT16LE]] iMapCode || ID used in map file
|-
| [[UINT8]] iTile || Index into the tileset for the image to use
|-
| [[UINT8]] iTileset || Index of tileset containing this tile's image (ignore upper two bits - see below)
|-
| [[UINT16LE]] iFlags || Flags for this tile (can stand on, can hurt player, etc.)
|-
| [[UINT8]] iLength || Length of tile name
|-
| [[char]] cName[iLength] || <tt>iLength</tt> characters for the tile name. This string is not NULL-terminated.
|}

Note that only the lower six bits of <tt>iTileset</tt> refer to the tile number. The purpose of the upper unknown bits is unknown. To get a valid tileset index use <code>iTileset & 0x3F</code>.

<tt>iFlags</tt> is broken up as follows:

{|class="wikitable"
!Bit!!Hex!!Name!!Description
|-
||-||0x0000||<zero>||Default solid block
|-
|1||0x0001||F_PLAYERTHRU||Blocks you can walk, jump or fall through (background tiles, the path on the overhead map, etc.)
|-
|2||0x0002||F_STAIR, F_NOTSTAIR (Xargon)||Blocks that you can stand on (can also jump up through when combined with F_PLAYERTHRU)
|-
|3||0x0004||F_VINE, F_NOTVINE (Xargon)||Can climb this block - usually combined with F_PLAYERTHRU (giving 0x0005)
|-
|4||0x0008||F_MSGTOUCH||Activates game-specific code when touched
|-
|5||0x0010||F_MSGDRAW|| Regular blocks have just one shape, f_msgdraw triggers <tt>msg_block(msg_draw)</tt> for animated blocks.
|-
|6||0x0020||F_MSGUPDATE|| game-specific code (through <tt>msg_block(msg_update)</tt>) at every frame. For animated blocks.
|-
|7||0x0040||F_INSIDE||This block contains text inside it
|-
|8||0x0080||F_FRONT|| object property : Foreground object
|-
|9||0x0100||F_TRIGGER||Unknown
|-
|10||0x0200||F_BACK || object property: Background object (e.g. torches)
|-
|10||0x0200||F_TINYTHRU|| (likely PlayerThru when player is in 'mini' mode, unused in Xargon)
|-
|11||0x0400||F_ALWAYS|| object property : "Always updates object"
|-
|12||0x0800||F_KILLABLE|| object property : monster can be killed with regular weapon.
|-
|13||0x1000||F_FIREBALL|| object property : object is a fireball
|-
|14||0x2000||F_WATER|| A water tile. regular player will sink, the S.U.B. and aquatic monster can swim through it, but not out of it
|-
|14||0x4000||F_NOT_WATER|| (Xargon) Not a water tile.
|-
|15||0x4000||F_WEAPON|| object property : object is a regular weapon
|-
|16||0x8000||(unused)||(unused)
|}

Note that the same "flag set" is used for both blocks and objects. Some properties only apply to blocks, some only apply to objects, some to both (<tt>f_msgtouch</tt>), and some flags have a different meaning for blocks and tile (e.g. 0x200 and 0x2000).

=== Object layer ===

The object layer is drawn in front of the background layer, and contains all the interactive elements of the map, such as points and enemies.

The object data starts straight after the background layer data, so that's at offset 16,384 bytes into the map file (8,192 tiles * two bytes per tile.) The first two bytes in the object layer are a 16-bit integer ([[UINT16LE]]) that stores the number of objects in the map, and this is followed by the data for each object, one after the other.

Each object is 31 bytes long, and is stored in the following structure:

{|class="wikitable"
!Data type!!Description
|-
|UINT8 iType||Object type (e.g. a "point item", or an enemy.)
|-
|UINT16 iX||X-coordinate of object
|-
|UINT16 iY||Y-coordinate of object
|-
|UINT16 iXD|| object horizontal speed
|-
|UINT16 iYD|| object vertical speed
|-
|UINT16 iWidth||Width of object
|-
|UINT16 iHeight||Height of object
|-
|UINT16 iState||Object sub-type (e.g. what type of "point item"), or current "State" (running, jumping, etc)
|-
|UINT16 iSubState||object-specific semantic
|-
|UINT16 iStateCount||object-specific semantic, typically a frame counter
|-
|UINT16 iCounter||Various uses. Often used to link doors or switches to obstacles.
|-
|UINT16 iFlags|| internally used for rendering.
|-
|UINT32 lPointer||Used internally as a pointer. If this value is 0, there is no entry for this object in the string stack (see below.) Any non-zero value means there is an entry for this object in the string stack.
|-
|UINT16 iInfo1||Unknown
|-
|UINT16 iZapHold||Unknown
|-
|}

At the present time it is assumed (perhaps hoped) that objects can be mapped to images in the same way as the tiles in the background layer can be mapped to images, but as yet there is no known way of doing this.

=== Savegame datas ===

Saved games in Jill are "snapshots" of the current level state, that's why some spare room exists in the map format to allow special data to be saved. The unsigned short integer is the level number (as displayed in the status screen). The second unsigned short integer is JILL's health. The next unsigned short integer is the amount of items displayed in the inventory. Each of the following 16 unsigned short integers represent an item in the inventory (note that used items such as keys are not removed from this stack, but items are rearranged to override the key value, according to the amount of items displayed in the inventory). Right after, the unsigned long integer stores the score. Then, there are 28 empty bytes to fill the block.

{|class="wikitable"
!InvItemNumber!!Description
|-
|0|| Morph: Jill
|-
|1|| Key: Red Key
|-
|2|| Weapon: Knive
|-
|3|| Key: Crystal Rock
|-
|4|| Morph: Frog
|-
|5|| Morph: Fire bird
|-
|6|| Bag of coins (?)
|-
|7|| Morph: Fish
|-
|8|| Weapon: Blade
|-
|9|| Bonus: High Jump
|-
|}

In Jill of the Jungle, this section is 70 bytes long. In Xargon it is 97 bytes long.

=== String stack ===

The Strings Stack is just a bunch of arbitrary strings (can be either text or file references). Each entry starts with an unsigned short integer defining the length of the incoming string. Note that the string is always followed by a null byte (so if "length of next entry" is 12, you only have the string size and should not forget to read an extra byte to reach the next entry). The string stack's entries are used for iType[20] ("write text"), 21 ("write text in big") and 12 ("checkpoints") and can contain music filenames, demo filenames, next level filenames or arbitrary text content.

In Xargon ans Jill, the checkpoint type contains a string:

* If the first character of this string is '*' then the rest of the string is taken to be the filename of the music file to play in that level.
* If the first character is '#' then the string is also a music file, but it is only played if there is no song currently playing, or the level number is between 1 and 32 inclusive. This is probably used for the main menu/credits/etc. so as not to interrupt the theme song when displaying those "levels", and it is used for the map level so the theme music keeps playing (rather than starting from the beginning again) when starting a game.
* The first character of the string can also be '&' which, in Xargon, forces the song to be <tt>song_33.xr1</tt> and in Jill does not change the song. The rest of the string as a macro filename, to be read and played back as a demo. This is used in the ending sequences.

== Object iTypes ==

Here's a list of objects used in Jill maps.

iXD and iYD defines both speed and direction of items and ennemies. Positive values goes to right and down while values under zero move the object left and up.
lPointer referes to a segment of memory and is likely used to store entries from the string stack, that's why the gap between two consecutive pointers equals 65536 (this is the maximum size in byte of a string in the stack)
Playable objects must be the first entry in the list to avoid a weird "scroll to first entity" bug in Jill

=== Functional ===

*iType[0] Playable: Jill (level)
:ObjectInfo1 (sometimes '-1'): usage unknown
*iType[23] Playable: Jill (map overview in Jill3)
*iType[54] Playable: Fish (never used in maps - if player dies, restart as Jill)
*iType[56] Playable: Firebird (never used in maps - if player dies, restart as Jill)
*iType[57] Playable: Frog (never used in maps - if player dies, restart as Jill)
*iType[12] Trigger: Checkpoint
:iCounter ('>= 0'): checkpoint/level number
:iPointer: pointer
:'''NOTE:''' Always lock access to previous checkpoint when the player reaches a new checkpoint. This item reads an entry from the string stack: a single-character code and a filename. If the code is "*", it means "load and play this song from the beginning". If the code is "#", it means "keep on playing this song". If the code is "!", then there's no filename and it means "load previous map". If there's no code, then the filename is the next level to load.
*iType[15] Trigger: Touch Trigger
:iCounter ('>= 0'): target tag
*iType[32] Trigger: Switch
:iState (usually '0'): switch position, if target is off, set to '1'
:iXD (usually '0'): set to '0' when triggering two objects with different start states (one bridge 'off' and a wall 'on' for exemple)
*iType[52] Trigger: Press Button
:iXD (set to '1' to face right, '-1' to face left): direction
:iState (set to '1' if target is off)
:iSubState''): usage unknown, rarely used
:iCounter ('>= 0'): target tag
*iType[24] Misc: Locked Door
:iYD (usually '0', set to '1' for crystal): required key type
:iCounter ('>= 0'): self tag
*iType[25] Misc: Collapsing ceiling
:iCounter ('>= 0'): self tag
*iType[26] Misc: Toggle Wall
:iXD (set to 1 for horizontal/floor)
:iYD (set to 1 for vertical/wall)
:iCounter ('>= 0'): self tag
:'''NOTE:''' If set as wall, must be placed on top of the wall, if set as floor, must be placed on the far left of the floor. By default, these walls are "off", use "ELEVMID" tiles for wall and "BRIDGE" for floor. Walls and bridges cannot go through two different types of tiles.
*iType[44] Misc: Knight
:iState (set to '1' for start on, '0' for start off): initial state
:iStateCount (set to '6' for 'none shall pass')
:iCounter ('>= 0'): self tag (toggle when triggered)
*iType[61] Misc: Lift
:iCounter (usually '0'): if set to '-1', do not return to initial state

=== Items & Bonus ===

*iType[1] Bonus: Apple
*iType[28] Bonus: Pickup Item & morphing icons
:iCounter ('>= 0'): item type (can be anything from 0 to 9 and matches the inventory item number)
*iType[2] Weapon: Knive
*iType[14] Key: Old Red Key
*iType[33] Key: Crystal
:iCounter (rarely set to '1'): usage unknown

=== Monsters ===

*iType[4] Green bug
:iXD (usually '2'): movement speed
*iType[7] Devil
*iType[8] Bunny
*iType[9] Worm
:iXD (usually '2'): movement speed
*iType[11] Giant Slug
:iXD (usually '2'): movement speed
*iType[17] Lizard Man
:iXD (usually '2'): movement speed
*iType[22] Frog
*iType[29] Giant Ant
:iXD (usually '3'): movement speed
*iType[30] Phoenix
:iXD (usually '3'): movement speed
*iType[39] Invincible Snake
:iXD (usually '2'): movement speed
*iType[43] Giant Bat
*iType[45] Hive
*iType[46] Bees
*iType[47] Crab
*iType[48] Gator
:iXD (usually '2'): movement speed
*iType[53] Ghost
:iXD (usually '2'): initial direction
:iCounter (usually '2'): movement speed
:'''NOTE:''' Ghosts move along the same tile type
*iType[59] Jellyfish
*iType[60] Eels

=== Traps ===

*iType[35] Rolling Stone
*iType[38] Falling Spike
:iCounter ('>= 0'): self tag (fall when triggered)
*iType[41] Boucing Ball
:iCounter (usually '4'): ball type (0-small, 3-red, 4-green)
*iType[65] Sparks
:iYD (usually '2'): movement speed
:'''NOTE:''' Sparks move along the same tile type

=== Misc ===

*iType[13] Misc: Prince
:iState (<code><nowiki>''</nowiki></code>): object animation frame
*iType[19] Misc: Cloud
:iCounter ('>= 0'): usage unknown
:iXD (<code><nowiki>''</nowiki></code>): movement speed
*iType[20] Misc: Write text (small capital letters)
:iXD (<code><nowiki>''</nowiki></code>): CGA color index number
:iYD (usually '-1' for transparent): background color
:lPointer: pointer
:'''NOTE:''' This item reads an entry from the string stack
*iType[21] Misc: Write text (big letters)
:iXD (<code><nowiki>''</nowiki></code>): CGA color index number
:iYD (usually '-1' for transparent): background color
:lPointer: pointer
:'''NOTE:''' This item reads an entry from the string stack
*iType[40] Misc: Underwater Rock
*iType[42] Misc: Huge letter
:iXD ('>= 0'): letter type (0-M, 1-E, 2-G, 3-A, 4-S)
:iCounter ('>= 0'): self tag (fall when triggered)
*iType[49] Misc: Epic Logo
*iType[51] Misc: Big Skull
:iCounter ('>= 0'): self tag (laugh with red gloomy eyes when triggered)
*iType[64] Misc: Eye
*iType[66] Misc: Flag
*iType[67] Misc: "Demo"/"Map" sign
:iXD (sign type, '>= 0'): set to '1' for "map", '0' for "demo"

=== Untested ===

*iType[3] ? (buggy/unusable)
*iType[5] ? (buggy/unusable)
*iType[10] ? (buggy/unusable)
*iType[16] ? (buggy/unusable)
*iType[27] ? (buggy/unusable)
*iType[34] ? (buggy/unusable)
*iType[50] ? (buggy/unusable)
*iType[55] ? (buggy/unusable)
*iType[6] Buggy: harmless firebird
*iType[18] Saves: Demon attack
:iSpeedX (<code><nowiki>''</nowiki></code>): Horizontal speed
:iSpeedY (<code><nowiki>''</nowiki></code>): Vertical speed
*iType[31] Saves: flame attack
*iType[36] Saves: Particle
:iState (<code><nowiki>''</nowiki></code>): color
:iSpeedX (<code><nowiki>''</nowiki></code>): velocity X
:iSpeedY (<code><nowiki>''</nowiki></code>): velocity Y
:iFlag (<code><nowiki>'16384'</nowiki></code>): Unknow
:iCounter (<code><nowiki>''</nowiki></code>): Unknow
*iType[37] Saves: Pain effect
*iType[58] Saves: Bubbles
:iFlag (<code><nowiki>'16384'</nowiki></code>): Unknow
*iType[62] Saves: Player attack (fireball)
*iType[63] Saves: Player attack (fish)

== Credits ==

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

[[Category:Jill of the Jungle]]
[[Category:File Formats]]
[[Category:Map Files]]