ModdingWiki - User contributions [en-gb]

KMD Format (Fury of the Furries)

2024-10-18T15:31:14Z

Carbon14: /* Pattern */

{{Stub}}
{{Music Infobox
| Type = Tracked
| Instruments = FM
| NumChannels = 6 + 5
| NumTracks = 1
| NumPatterns = 128
| NumOrders = 1
| Tags = Instrument names
| Games =
{{Game|Fury of the Furries}}
}}

This format is used in [[Fury of the Furries]] for music. It is a modified version of the [[MOD Format|MOD music format]] using FM instruments rather than samples. The instruments are simple described in terms of the register settings for an [[OPL chip]] synthesizer on an Adlib or Soundblaster card.

It's name *might* be based on Kalisto MOD Format, but this is speculation.

The file has 6 MOD channels, and a further 5 channels devoted to just percussion, these oddities mean that it is unlikely that there are any MOD file players or tools which can handle this format.

Most MOD players expect PCM samples for the instrument sounds, but the [[S3M Format]] used by Scream Tracker 3 has the option to handle this kind of OPL-FM instrument.

2 music files are provided for each stage of the game, The game menu allows you to choose between 'fun' or 'classical' and this determines which of the music files is used for each stage.

== Header ==

{|class="wikitable"
! Data type !! Name !! Description
|-
| UINT8 || Instrument count || Number of instruments in the file.
|-
| UINT8 || Pattern count || Number of patterns in the file.
|-
| UINT8 || End of song || End of song instruction. Usually 127. In PYRAMIDE.KMD it is 120.
|-
| UINT8(128) || Pattern table || Order in which to play the patterns.
|-
| UINT8(7) || Unknown || meaning currently unknown.
|}

== Instrument ==

The KMD format uses FM instruments, directly specifying register values for a [[OPL chip|Yamaha OPL-2]] compatible synthesizer, such as that found on an Adlib or SoundBlaster. As such, the file contains NO sample data, and where you might expect details of the samples, instead we have these instrument definitions.

{|class="wikitable"
! Data type !! Name !! Description
|-
| CHAR(16) || Instrument name || The name of the instrument, if less than 16 characters it is NULL-terminated
|-
| UINT8 || Op1 Trem/Vib/Sus/KSR/F || Operator 1 Tremolo / Vibrato / Sustain / Key Scale Rate / Frequency Multiplication Factor
|-
| UINT8 || Op2 Trem/Vib/Sus/KSR/F || Operator 2 Tremolo / Vibrato / Sustain / Key Scale Rate / Frequency Multiplication Factor
|-
| UINT8 || Op1 KSL/Level || Operator 1 Key Scale Level / Output Level
|-
| UINT8 || Op2 KSL/Level || Operator 2 Key Scale Level / Output Level
|-
| UINT8 || Op1 A/D || Operator 1 Attack Rate / Decay Rate
|-
| UINT8 || Op2 A/D || Operator 2 Attack Rate / Decay Rate
|-
| UINT8 || Op1 S/R || Operator 1 Sustain Level / Release Rate
|-
| UINT8 || Op2 S/R || Operator 2 Sustain Level / Release Rate
|-
| UINT8 || Op1 Wave || Operator 1 Waveform
|-
| UINT8 || Op2 Wave || Operator 2 Waveform
|-
| UINT8 || FB/Add || Feedback / Additive or FM select
|-
| UINT8 || Percussion || Indicates type of instrument
|}

{|class="wikitable"
! Percussion value !! Description
|-
| 0 || This is a melodic instrument and will be played using 2 FM operators
|-
| 1 || Bass drum. Will be played using the bass drum channel on the OPL synthesizer
|-
| 2 || Snare drum. Will be played using the snare drum channel
|-
| 3 || Tom. Will be played using the tom drum channel
|-
| 4 || Cymbal. This value is not seen in any files, but is assumed to be the top cymbal according to the synthesizer's feature set
|-
| 5 || Hi-hat. Will be played using the hi-hat channel
|-
| FF || Instrument deleted. This instrument is not used in the song
|}

== Pattern ==

Each pattern consists of 64 steps. Normally the steps are played one after the other until the end of the pattern, and then the next pattern from the Pattern Table is started. The speed of the song dictates how much time elapses between each step being played. Normally trackers run at 50 ticks per second, so a speed of 5 would play 10 steps per second. However, since Fury of the Furries runs at 60fps, it is possible that there are 60 ticks per second in this format.

Each step is 30 bytes long. It contains 6 4-byte values, one for each melodic channel, and a further 6 bytes to control the percussion. A dedicated percussion system is unusual in mod format, and this ties this format quite tightly to the capabilities of the Yamaha OPL2 synthesizer chip. A full pattern will be 64 * 30 = 1920 bytes in length.

{|class="wikitable"
! Data type !! Name !! Description
|-
| UINT8 || Channel 1 Pitch || Note pitch in semitones.
|-
| UINT8 || Channel 1 Instrument || Instrument number (i.e. a value of 2 means the 2nd instrument defined in the file)
|-
| UINT8 || Channel 1 Effect Type || Type of player effect.
|-
| UINT8 || Channel 1 Effect Parameter || Parameter for effect
|-
| UINT8[4] || Channel 2 || Pitch, Instrument, Effect as for Channel 1
|-
| UINT8[4] || Channel 3 || ...
|-
| UINT8[4] || Channel 4 || ...
|-
| UINT8[4] || Channel 5 || ...
|-
| UINT8[4] || Channel 6 || ...
|-
| UINT8 || Percussion Note On || Bit flags to trigger the 5 percussion instruments <pre>High bit -- -- -- BD SN TM CY HH Low bit</pre>
|-
| UINT8[5] || Unknown || Probably volume control for each of the 5 percussion instruments.
|}

== Credits ==

This file format was reverse engineered by [[User:Carbon14|carbon14]]. 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!)

KMD Format (Fury of the Furries)

2024-10-18T15:30:21Z

Carbon14: Add known detail of pattern structure

{{Stub}}
{{Music Infobox
| Type = Tracked
| Instruments = FM
| NumChannels = 6 + 5
| NumTracks = 1
| NumPatterns = 128
| NumOrders = 1
| Tags = Instrument names
| Games =
{{Game|Fury of the Furries}}
}}

This format is used in [[Fury of the Furries]] for music. It is a modified version of the [[MOD Format|MOD music format]] using FM instruments rather than samples. The instruments are simple described in terms of the register settings for an [[OPL chip]] synthesizer on an Adlib or Soundblaster card.

It's name *might* be based on Kalisto MOD Format, but this is speculation.

The file has 6 MOD channels, and a further 5 channels devoted to just percussion, these oddities mean that it is unlikely that there are any MOD file players or tools which can handle this format.

Most MOD players expect PCM samples for the instrument sounds, but the [[S3M Format]] used by Scream Tracker 3 has the option to handle this kind of OPL-FM instrument.

2 music files are provided for each stage of the game, The game menu allows you to choose between 'fun' or 'classical' and this determines which of the music files is used for each stage.

== Header ==

{|class="wikitable"
! Data type !! Name !! Description
|-
| UINT8 || Instrument count || Number of instruments in the file.
|-
| UINT8 || Pattern count || Number of patterns in the file.
|-
| UINT8 || End of song || End of song instruction. Usually 127. In PYRAMIDE.KMD it is 120.
|-
| UINT8(128) || Pattern table || Order in which to play the patterns.
|-
| UINT8(7) || Unknown || meaning currently unknown.
|}

== Instrument ==

The KMD format uses FM instruments, directly specifying register values for a [[OPL chip|Yamaha OPL-2]] compatible synthesizer, such as that found on an Adlib or SoundBlaster. As such, the file contains NO sample data, and where you might expect details of the samples, instead we have these instrument definitions.

{|class="wikitable"
! Data type !! Name !! Description
|-
| CHAR(16) || Instrument name || The name of the instrument, if less than 16 characters it is NULL-terminated
|-
| UINT8 || Op1 Trem/Vib/Sus/KSR/F || Operator 1 Tremolo / Vibrato / Sustain / Key Scale Rate / Frequency Multiplication Factor
|-
| UINT8 || Op2 Trem/Vib/Sus/KSR/F || Operator 2 Tremolo / Vibrato / Sustain / Key Scale Rate / Frequency Multiplication Factor
|-
| UINT8 || Op1 KSL/Level || Operator 1 Key Scale Level / Output Level
|-
| UINT8 || Op2 KSL/Level || Operator 2 Key Scale Level / Output Level
|-
| UINT8 || Op1 A/D || Operator 1 Attack Rate / Decay Rate
|-
| UINT8 || Op2 A/D || Operator 2 Attack Rate / Decay Rate
|-
| UINT8 || Op1 S/R || Operator 1 Sustain Level / Release Rate
|-
| UINT8 || Op2 S/R || Operator 2 Sustain Level / Release Rate
|-
| UINT8 || Op1 Wave || Operator 1 Waveform
|-
| UINT8 || Op2 Wave || Operator 2 Waveform
|-
| UINT8 || FB/Add || Feedback / Additive or FM select
|-
| UINT8 || Percussion || Indicates type of instrument
|}

{|class="wikitable"
! Percussion value !! Description
|-
| 0 || This is a melodic instrument and will be played using 2 FM operators
|-
| 1 || Bass drum. Will be played using the bass drum channel on the OPL synthesizer
|-
| 2 || Snare drum. Will be played using the snare drum channel
|-
| 3 || Tom. Will be played using the tom drum channel
|-
| 4 || Cymbal. This value is not seen in any files, but is assumed to be the top cymbal according to the synthesizer's feature set
|-
| 5 || Hi-hat. Will be played using the hi-hat channel
|-
| FF || Instrument deleted. This instrument is not used in the song
|}

== Pattern ==

Each pattern consists of 64 steps. Normally the steps are played one after the other until the end of the pattern, and then the next pattern from the Pattern Table is started. The speed of the song dictates how much time elapses between each step being played. Normally trackers run at 50 ticks per second, so a speed of 5 would play 10 steps per second. However, since Fury of the Furries runs at 60fps, it is possible that there are 60 ticks per second in this format.

Each step is 30 bytes long. It contains 6 4-byte values, one for each melodic channel, and a further 6 bytes to control the percussion. A dedicated percussion system is unusual in mod format, and this ties this format quite tightly to the capabilities of the Yamaha OPL2 synthesizer chip.

{|class="wikitable"
! Data type !! Name !! Description
|-
| UINT8 || Channel 1 Pitch || Note pitch in semitones.
|-
| UINT8 || Channel 1 Instrument || Instrument number (i.e. a value of 2 means the 2nd instrument defined in the file)
|-
| UINT8 || Channel 1 Effect Type || Type of player effect.
|-
| UINT8 || Channel 1 Effect Parameter || Parameter for effect
|-
| UINT8[4] || Channel 2 || Pitch, Instrument, Effect as for Channel 1
|-
| UINT8[4] || Channel 3 || ...
|-
| UINT8[4] || Channel 4 || ...
|-
| UINT8[4] || Channel 5 || ...
|-
| UINT8[4] || Channel 6 || ...
|-
| UINT8 || Percussion Note On || Bit flags to trigger the 5 percussion instruments <pre>High bit -- -- -- BD SN TM CY HH Low bit</pre>
|-
| UINT8[5] || Unknown || Probably volume control for each of the 5 percussion instruments.
|}

== Credits ==

This file format was reverse engineered by [[User:Carbon14|carbon14]]. 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!)

MOD Format

2024-10-18T15:06:51Z

Carbon14: /* Patterns */ Filling out effects details

{{Music Infobox
| Type = Tracked
| Instruments = FM or samples
| NumChannels = 4 - 8
| NumTracks = 1
| NumPatterns = 128
| NumOrders = 1
| Tags = Instrument names
| Games =
{{Game|Fury of the Furries}}
{{Game|Halloween Harry}}
{{Game|Unreal Tournament}}
}}

MOD is a name for a family of file formats typically used by a style of music player called a tracker. There have been many trackers and tracker style music libraries over the years, and as a result a number of variations of the format have developed.

Typically MOD files include sampled sounds, but some formats rely on an FM synthesizer instead, or as well.

Hopefully this page will outline the general principles of the MOD format. Follow the links for more specific details of actual MOD formats used by specific games.

== Overview ==

The MOD format typically comprises 4 pieces of information.

* A header which contains global information such as a song title and overall volume, as well an the number of entries in each of the other sections.
* An instrument table, containing one or more instruments, sounds that should be used to play the music. Most often these are audio samples, but some MOD formats allow for FM synth instruments.
* A pattern table, which indicates the order in which patterns should be played.
* The patterns themselves. Short sections of the song, represented as notes and effects.

The patterns are played one at a time, using the order laid down in the pattern table.

== Header section ==

{|class="wikitable"
! Data type !! Name !! Description
|-
| char[20] || Title || Song title, if not 20 characters long it will be null terminated.
|-
| char[22] || Sample 1 name || Name of the first sample, if not 22 characters long it will be null terminated.
|-
| UINT16BE || Sample 1 length || Length in 2-byte words of the first sample.
|-
| INT8 || Sample 1 finetune ||
|-
| UINT8 || Sample 1 volume ||
|-
| UINT16BE || Sample 1 repeat offset || Position in sample 1 to repeat from, when the note is held. In 2-byte words.
|-
| UINT16BE || Sample 1 repeat length || Length in 2-byte words of sample 1 repeat section.
|-
| char[22] || Sample 2 name || Name of the second sample...
|-
| || etc || Typically there will be 15 or 31 samples in the file, depending on the specific format.
|-
| UINT8 || Number of patterns || This is the number of patterns that need to be played, not necessarily the number of different patterns in the file. Some patterns may be played more than once.
|-
| UINT8 || Song end || What happens when the Number of patterns has been played.
|-
| UINT8[128] || Pattern table || The file contains at up to 128 different patterns, this table is the order in which patterns should be played.
|-
| FOURCC || File format tag || Code to indicate the specific tracker/MOD format.
|}

== Pattern Table ==

The pattern table is fixed length, usually 128 bytes in length. Each byte indicates the number of a pattern to be played, and the total number of patterns to be played to complete the song is given in the Number of patterns byte. If a song contained a verse, chorus and bridge, (patterns 0, 1 and 2 respectively) then it might contain a pattern table <pre>00 00 01 00 01 02 00 01 01 01</pre> to play verse, verse, chorus, verse, chorus, bridge, verse, chorus, chorus, chorus.

The Song end byte indicates what happens when the number of patterns have been played. If this byte is greater than or equal to 127, the song will end. Otherwise it represents a position in the pattern table, where playing should continue, which allows the song to repeat, but it could have a non-repeating intro, played only the first time through.

== Patterns ==

The patterns are stored sequentially. The best way to identify the number of patterns in the file is to find the largest pattern number used in the pattern table and add 1. Sample data will usually follow directly after the last pattern.

Each patterns contains 64 lines or steps. The MOD file will contain a number of different sound channels that play simultaneously, 4, 6 and 8-channel formats are common, and the specific format will indicate how many channels there should be. Each channel requires 4 bytes per step. So a 6 channel MOD file will require 4 * 6 * 64 bytes per pattern. Those 4 bytes in some order need to encode:

* The instrument (a sample number from 1 - 15 (or 1 - 31).
* The pitch of the note.
* An optional effect

The 4 bytes are broken into nibbles like so:

{|class="wikitable"
! Byte 1 High !! Byte 1 Low !! Byte 2 !! Byte 3 High !! Byte 3 Low !! Byte 4
|-
| wwww || XXXX || xxxxxxxx || yyyy || ZZZZ || uuuuvvvv
|}

wwwwyyyy is the sample number (which instrument)

XXXXxxxxxxxx is an indication of the note pitch (for sampled data this is usually a period value)

ZZZZuuuuvvvv is an optional effect

Effects (in these effects, a tick is 1/50th of a second) :

{|class="wikitable"
! ZZZZ !! name !! treat arguments as !!description
|-
| 0 || Arpeggio || uuuu vvvv || Play the original note, then the note plus xxxx semitones, then the note plus yyyy semitones: each for 1/3 of the step time
|-
| 1 || Slide Up || uuuuvvvv || Increment the pitch (XXXXxxxxxxxx) by uuuuvvvv semitones every tick, so that the pitch increases during the step.
|-
| 2 || Slide Down || uuuuvvvv || Decremunt the pitch (XXXXxxxxxxxx) by uuuuvvvv semitones every tick, so that the pitch decreases during the step.
|-
| 3 || Tone Portamento || uuuuvvvv || Start the note at the same frequency as the previous note. Each tick, move the period uuuuvvvv closer to the XXXXxxxxxxxx period, until either it reaches XXXXxxxxxxxx or you get to the next step.
|-
| 4 || Vibrato || uuuu vvvv || Adjust the sample pitch up and down with an amplitude of +/- vvvv semitones at a rate of (uuuu * speed)/64 oscillations during the step.
|-
| 5 || Tone Portamento + Volume Slide || uuuu vvvv || Adjust the volume of the channel while an existing effect 3 (Tone Portamento) is occurring. if uuuu is nonzero, the volume is increased, if vvvv is nonzero, the volume is decreased. The volume is changed by the value each tick until there is a new effect.
|-
| 6 || Vibrato + Volume Slide || uuuu vvvv || Adjust the volume of the channel while an existing effect 4 (Vibrato) is occurring. If uuuu is nonzero, the volume is increased, if vvvv is nonzero, the volume is decreased. The volume is changed by the value each tick until there is a new effect.
|-
| 7 || Tremolo || uuuu vvvv || Adjust the sample volume up and down with an amplitude of vvvv * (speed - 1) such than (uuuu * speed)/64 oscillations occur during the step.
|-
| 8 || Set Panning Position || uuuuvvvv || Set the channel panning position using uuuuvvvv. 0 is all the way to the left, 255 is all the way to the right.
|-
| 9 || Set Sample Offset || uuuuvvvv || Start the sample from some point in the middle rather than the beginning. multiply uuuuvvvv by 256 to get the start position in bytes from the beginning of the sample. If no sample is specified by wwwwyyyy, then the most recently played sample is retriggered.
|-
| A || Volume Slide || uuuu vvvv || Change the volume of samples on this channel. If uuuu is nonzero, the volume is increased, if vvvv is nonzero, the volume is decreased. The volume is changed by the value each tick until there is a new effect.
|-
| B || Position Jump || uuuuvvvv || Jump to the start of a new pattern. uuuuvvvv gives a position in the Pattern Table to jump to. Note this is not a pattern number, but a position in the pattern table.
|-
| C || Set Volume || uuuuvvvv || Set the volume on this channel to uuuuvvvv. Legal volumes are in the range 0 to 64. This is true for all volume effects.
|-
| D || Pattern Break || uuuu vvvv || Jump straight to the start of the NEXT pattern in the pattern table. uuuu * 10 + vvvv is the step number in the pattern to start at. Note that there is a decimal 10 in that calculation, not 16.
|-
| E || Extended Effects || || See extended effects table below
|-
| F || Set Speed || uuuuvvvv || Set the speed of the playback. Often this effect will appear in one of the channels in the first step of the first pattern to be played, to set the song speed at the beginning. uuuuvvvv gives the number of ticks per step. During a song, this effect causes a speed change on the NEXT step. Valid speed values are from 1 to 31. A value larger than 31 should instead be interpreted as a value in beats per minute. 4 steps make up one beat in this scenario (therefore a single step equates to a sixteenth-note or a semiquaver). If no speed has been set in the first step, then the default speed is 6.
|}

Extended effects

{|class="wikitable"
! ZZZZ !! uuuu !! name !! description
|-
| E || 0 || Set filter on/off || turn on a hardware filter if vvvv is non-zero, off otherwise.
|-
| E || 1 || Fineslide up || Functions like effect 1, but changes the pitch just once at the beginning of the step.
|-
| E || 2 || Fineslide down || Functions like effect 2, but changes the pitch just once at the beginning of the step.
|-
| E || 3 || Set glissando on/off || If vvvv is 1 turn on glissando, if 0 turn it off. While glissando is one, note slides occur at half a semitone at a time instead of 1 semitone.
|-
| E || 4 || Set vibrato waveform || Sets the waveform to be used for effect 4 vibrato. 0 is sine, 1 is a falling ramp, 2 is square, 3 is random, each retriggering when a new note is selected. 4 - 7 give the same waveforms, but without retriggering.
|-
| E || 5 || Set finetune value || When calculating the sample playback period for any given pitch, there is a finetune component. This effect overrides that finetune, to allow you to slightly detune a channel
|-
| E || 6 || Loop pattern || Specifies a looping section of a pattern. If vvvv is zero, this is the first step in the loop. If vvvv is nonzero it is the last step of the loop AND indicates how many times the loop should be played.
|-
| E || 7 || Set tremolo waveform || Sets the waveform to be used for effect 7 tremolo. The options are the same as for effect E4 above.
|-
| E || 8 || Rough panning || Sets the panning, not often implemented, less finesse than effect 8. 0 is all left, 15 is all right.
|-
| E || 9 || Retrigger sample || Retrigger the sample vvvv ticks into the step, and every vvvv ticks after that until the end of the step.
|-
| E || A || Fine volume slide up || Increase the volume of the channel by vvvv points just once.
|-
| E || B || Fine volume slide down || Decrease the volume of the channel by vvvv points just once.
|-
| E || C || Cut sample || Set the volume of the current sample to 0 AFTER vvvv ticks (Do not change the overall channel volume).
|-
| E || D || Delay sample || Delay the triggering of the sample until vvvv ticks in the step.
|-
| E || E || Delay pattern || Extend the length of the current step by vvvv steps. If the current speed was 6 ticks per step, then a value of 4 would cause this step to last 6 + 6 * 4 = 30 ticks. All notes and effects continue to play during this extension.
|-
| E || F || Invert loop || Play samples backward at a speed of vvvv.
|}

== Sample data ==

After the patterns the file contains sample data. This is in 8-bit two's complement mono format. Each of the samples follows on from the previous, the file header will have indicated the length (in 16-bit words) of each of the samples.

== Specific MOD formats ==

Remember that this is just a general form for MOD files, each specific format will have it's own details, and may differ in important ways.

[[4MD Format]]

[[KMD Format (Fury of the Furries)]]

[[S3M Format]]

== External sources ==

[https://github.com/lclevy/unmo3/blob/master/spec/mod.txt mod.txt] Link to a github copy of a file written many years ago by THUNDER (kurtt@sfu.ca) and revised and expanded by ByteRaver (erlandvo@hotmail.com)

MOD Format

2024-10-17T07:27:51Z

Carbon14: /* Patterns */ adjust line breaks

KMD Format (Fury of the Furries)

2024-10-16T15:12:18Z

Carbon14: /* Instrument */

KMD Format (Fury of the Furries)

2024-10-16T14:53:21Z

Carbon14: /* Instrument */ Add details of percussion settings.

{{Stub}}
{{Music Infobox
| Type = Tracked
| Instruments = FM
| NumChannels = 6 + 5
| NumTracks = 1
| NumPatterns = 128
| NumOrders = 1
| Tags = Instrument names
| Games =
{{Game|Fury of the Furries}}
}}

This format is used in [[Fury of the Furries]] for music. It is a modified version of the [[MOD Format|MOD music format]] using FM instruments rather than samples. The instruments are simple described in terms of the register settings for an [[OPL chip]] synthesizer on an Adlib or Soundblaster card.

It's name *might* be based on Kalisto MOD Format, but this is speculation.

The file has 6 MOD channels, and a further 5 channels devoted to just percussion, these oddities mean that it is unlikely that there are any MOD file players or tools which can handle this format.

Most MOD players expect PCM samples for the instrument sounds, but the [[S3M Format]] used by Scream Tracker 3 has the option to handle this kind of OPL-FM instrument.

2 music files are provided for each stage of the game, The game menu allows you to choose between 'fun' or 'classical' and this determines which of the music files is used for each stage.

== Header ==

{|class="wikitable"
! Data type !! Name !! Description
|-
| UINT8 || Instrument count || Number of instruments in the file.
|-
| UINT8 || Pattern count || Number of patterns in the file.
|-
| UINT8 || End of song || End of song instruction. Usually 127. In PYRAMIDE.KMD it is 120.
|-
| UINT8(128) || Pattern table || Order in which to play the patterns.
|-
| UINT8(7) || Unknown || meaning currently unknown.
|}

== Instrument ==

The KMD format uses FM instruments, directly specifying register values for a [[OPL chip|Yamaha OPL-2]] compatible synthesizer, such as that found on an Adlib or SoundBlaster. As such, the file contains NO sample data, and where you might expect details of the samples, instead we have these instrument definitions.

{|class="wikitable"
! Data type !! Name !! Description
|-
| CHAR(16) || Instrument name || The name of the instrument, if less than 16 characters it is NULL-terminated
|-
| UINT8 || Op1 Trem/Vib/Sus/KSR/F || Operator 1 Tremolo / Vibrato / Sustain / Key Scale Rate / Frequency Multiplication Factor
|-
| UINT8 || Op2 Trem/Vib/Sus/KSR/F || Operator 2 Tremolo / Vibrato / Sustain / Key Scale Rate / Frequency Multiplication Factor
|-
| UINT8 || Op1 KSL/Level || Operator 1 Key Scale Level / Output Level
|-
| UINT8 || Op2 KSL/Level || Operator 2 Key Scale Level / Output Level
|-
| UINT8 || Op1 A/D || Operator 1 Attack Rate / Decay Rate
|-
| UINT8 || Op2 A/D || Operator 2 Attack Rate / Decay Rate
|-
| UINT8 || Op1 S/R || Operator 1 Sustain Level / Release Rate
|-
| UINT8 || Op2 S/R || Operator 2 Sustain Level / Release Rate
|-
| UINT8 || Op1 Wave || Operator 1 Waveform
|-
| UINT8 || Op2 Wave || Operator 2 Waveform
|-
| UINT8 || FB/Add || Feedback / Additive or FM select
|-
| UINT8 || Percussion || Indicates type of instrument
|}

{|class="wikitable"
! Percussion value !! Description
|-
| 0 || This is a melodic instrument and will be played using 2 FM operators
|-
| 1 || Bass drum. Will be played using the bass drum channel on the OPL synthesizer
|-
| 2 || Snare drum. Will be played using the snare drum channel
|-
| 3 || Tom. This value is not seen in any files, but is assumed to be the tom drum because that fits with the synthesizer's feature set
|-
| 4 || Cymbal. This value is not seen in any files, but is assumed to be the top cymbal according to the synthesizer's feature set
|-
| 5 || Hi-hat. Will be played using the hi-hat channel
|-
| FF || Instrument deleted. This instrument is not used in the song
|}

== Credits ==

This file format was reverse engineered by [[User:Carbon14|carbon14]]. 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!)

MOD Format

2024-10-16T14:37:57Z

Carbon14: /* Patterns */

MOD Format

2024-10-16T14:37:13Z

Carbon14: Add effects table

Talk:MOD Format

2024-10-14T15:49:42Z

Carbon14:

There are so many different variations of MOD/Tracker files, that it seemed to me it would be a good idea to have a general overview page, with links to any specific formats that are used in games. This isn't the right wiki for a comprehensive encyclopaedia of trackers and their formats, but a few games do use specific tracked music format.[[User:Carbon14|Carbon14]] ([[User talk:Carbon14|talk]]) 15:14, 11 October 2024 (GMT)

KMD Format (Fury of the Furries)

2024-10-14T15:46:02Z

Carbon14: Add header and FM instrument detail

MOD Format

2024-10-14T15:14:00Z

Carbon14: Fix table closure

MOD Format

2024-10-14T15:10:34Z

Carbon14: Flesh out page

MOD Format

2024-10-11T15:14:56Z

Carbon14:

{{Stub}}
{{Music Infobox
| Type = Tracked
| Instruments = FM or samples
| NumChannels = 4 - 8
| NumTracks = 1
| NumPatterns = 128
| NumOrders = 1
| Tags = Instrument names
}}

MOD is a name for a family of file formats typically used by a style of music player called a tracker. There have been many trackers and tracker style music libraries over the years, and as a result a number of variations of the format have developed.

Typically MOD files include sampled sounds, but some formats rely on an FM synthesizer instead, or as well.

Hopefully this page will outline the general principles of the MOD format.

== External sources ==

[https://github.com/lclevy/unmo3/blob/master/spec/mod.txt mod.txt] Link to a github copy of a file written many years ago by THUNDER (kurtt@sfu.ca) and revised and expanded by ByteRaver (erlandvo@hotmail.com)

Talk:MOD Format

2024-10-11T15:14:37Z

Carbon14: Clarification as to the current state of this page.

I have started this page, and included a link to my primary reference material. I intend to summarise that reference material to give an outline of the format. Specific games that use MOD files may well use specific variations, and it seems to me that it makes sense to have a general page to outline the basic principles and specific variant pages, rather than many pages with almost identical content. I am well aware that I might fail to get round to this task, and so it seemed useful to at least get a link to a very good resource to start with. If you feel I'm going about this the wrong way, feel free to say so. [[User:Carbon14|Carbon14]] ([[User talk:Carbon14|talk]]) 15:14, 11 October 2024 (GMT)

MOD Format

2024-10-11T15:11:06Z

Carbon14: Starting page on the MOD music format

{{Stub}}
{{Music Infobox
| Type = Tracked
| Instruments = FM or samples
| NumChannels = 4 - 8
| NumTracks = 1
| NumPatterns = 128
| NumOrders = 1
| Tags = Instrument names
}}

MOD is a name for a family of file formats typically used by a style of music player called a tracker. There have been many trackers and tracker style music libraries over the years, and as a result a number of variations of the format have developed.

Typically MOD files include sampled sounds, but some formats rely on an FM synthesizer instead, or as well.

Hopefully this page will outline the general principles of the MOD format.

== External sources ==

[https://github.com/lclevy/unmo3/blob/master/spec/mod.txt mod.txt] Link to a github copy of a file written many years ago my THUNDER (kurtt@sfu.ca) and revised and expanded by ByteRaver (erlandvo@hotmail.com)

ImHex

2024-10-10T15:39:32Z

Carbon14: Added more detail

{{Tool Infobox
| Platform = Windows, Linux, macOS, online
| Release = 2020/11/12
| Homepage = [https://imhex.werwolv.net/ Homepage]
| Download = [https://imhex.werwolv.net/ Download links on the homepage]
| Edit1 = Hex editing
}}

'''ImHex''' is a powerful hex editor with many additional tools built it.

In addition to editing binary files, it features a powerful pattern language, which allows you to mark up parts of the file, to help you visualise the structure of the file. Particularly useful when trying to understand an undocumented file format.

It also has many additional features built-in including data visualization, a graphing calculator, LLVM demangler, diffing and disassemblers for 18 different architectures.

It's still a work in progress, and has some quirks, but it is under active development. Your mileage might vary

== Platform and license ==

It's written in c++ and is completely free and open source under the GPLv2.

== Documentation ==

[https://docs.werwolv.net/imhex Main documentation]

[https://docs.werwolv.net/pattern-language Pattern Language documentation]

== Disassembler architectures ==

* ARM
* AArch64
* MIPS
* Intel x86
* PowerPC
* SPARC
* SystemZ
* XCore
* Motorola 68K
* TMS320C64x
* M680x
* Ethereum Virtual Machine
* MOS Technology 65xx
* WebAssembly
* Berkeley Packet Filter
* RISC-V
* SuperH
* Tricore

== Example pattern script ==

This script which can be run in ImHex, marks up the individual files in a [[DAT Format (Fury of the Furries)]] file, and decompresses each into a separate file within a virtual file system in the ImHex editor.

<pre>
/*!
Deconstruct a Fury of the Furries DAT archive

Running this pattern will extract and decompress the archive into the Virtual Filesystem
*/

#pragma endian little
#pragma pattern_limit 2000000

import std.string;
import std.core;
import std.io;
import hex.core;
import type.base;

std::mem::Section currentSection;
s32 currentOffset = 0;

// Is the archived file compressed
enum Compressed : u8 {
Yes,
No
};

fn addSpace() {
u8 space[18] @ 0 in currentSection;
for (u8 i = 0, i < 18, i = i + 1) {
space[i] = 0x20;
}
};

// Copy a run length section from earlier in the compressed file
fn outputRunLengthCopy(auto length, auto offset) {
while (length > 0) {
std::mem::copy_section_to_section(currentSection, offset + 18, currentSection, currentOffset + 18, 1);
offset = offset + 1;
currentOffset = currentOffset + 1;
length = length - 1;
}
};

// A pair of bytes representing a run length
struct CompressionPair {
u16 shadowPair [[hidden, no_unique_address]];
u8 length = ((shadowPair >> 8) & 0x0f) + 3;
u16 offset = ((shadowPair >> 12) << 8) + (shadowPair & 0xff) + 18;
s32 fullOffset = offset + (currentOffset & 0xfffff000);
if (fullOffset >= currentOffset) {
fullOffset = fullOffset - 4096;
}
str comment = std::string::to_string(length) + " bytes @ " + type::impl::format_number(fullOffset, "0x{:02X}");

u16 pair [[comment(comment)]];

outputRunLengthCopy(length, fullOffset);
} [[inline]];

// A single byte literal
struct CompressionLiteral {
u8 byte;
} [[inline]];

// Either a single byte literal, or a run-length pair
struct CompressionItem {
u8 index = std::core::array_index();
u8 flag = (parent.flags >> index) & 0x01;
if (flag) {
CompressionLiteral byte;
std::mem::copy_value_to_section(byte, currentSection, currentOffset + 18);
currentOffset = currentOffset + 1;
}
else {
CompressionPair pair;
}
if ($ >= parent.parent.parent.end) {
break;
}
} [[inline]];

// A set up up to 8 compression items controlled by a flag bitfield
struct CompressionBlock {
u8 flags [[color("008800")]];
CompressionItem parts[8] [[inline]];
};

// A compressed data file
struct CompressedData {
CompressionBlock data[while($ < parent.end)];
} [[inline]];

// A single file within the archive
struct File {
char name[13] [[color("00ff00")]];
u32 uncompressedSize [[color("00ee00")]];
u32 compressedSize [[color("00dd00")]];

// create decompression section
Compressed isCompressed [[color("00cc00")]];
currentSection = std::mem::create_section(name);
std::mem::set_section_size(currentSection, uncompressedSize + 18);
addSpace();
u8 buffer[uncompressedSize] @ 18 in currentSection;
currentOffset = 0;

u32 end = $ + compressedSize;
if (isCompressed == 0) {
CompressedData compressedData [[color("000000")]];
}
else {
u8 data[compressedSize] [[color("000000")]];
std::mem::copy_value_to_section(data, currentSection, 18);
}
str fileName = std::string::to_string(name);
hex::core::add_virtual_file(fileName, buffer);
std::mem::delete_section(currentSection);
} [[name(name)]];

// A dat archive
struct Archive {
u16 fileCount [[color("ff0000"), name("Number of files")]];
File files[fileCount] [[inline]];
} [[inline]];

Archive archive @ 0x00;
</pre>

Category:Hex editing tools

2024-10-10T15:30:12Z

Carbon14: Add hex editor category

[[Category:Modding Tools]]

File:ImHex.png

2024-10-10T15:27:26Z

Carbon14: Example of ImHex hex editor, showing editor, with patterns marked up, and with a pattern in the pattern editor which has decompressed the main file, into a virtual file system

== Summary ==
Example of ImHex hex editor, showing editor, with patterns marked up, and with a pattern in the pattern editor which has decompressed the main file, into a virtual file system

ImHex

2024-10-10T15:24:03Z

Carbon14: Adding information about ImHex hex editor

{{Tool Infobox
| Platform = Windows, Linux, macOS, online
| Release = 2020/11/12
| Homepage = [https://imhex.werwolv.net/ Homepage]
| Download = [https://imhex.werwolv.net/ Download links on the homepage]
| Edit1 = Hex editing
}}

'''ImHex''' is a powerful hex editor with many additional tools built it.

In addition to editing binary files, it features a powerful pattern language, which allows you to mark up parts of the file, to help you visualise the structure of the file. Particularly useful when trying to understand an undocumented file format.

It also has many additional features built-in including data visualization, a graphing calculator, LLVM demangler, diffing and disassemblers for 18 different architectures.

It's still a work in progress, and has some quirks, but it is under active development. Your mileage might vary

== Platform and license ==

It's written in c++ and is completely free and open source under the GPLv2.

==Example pattern script==

This script which can be run in ImHex, marks up the individual files in a [[DAT Format (Fury of the Furries)]] file, and decompresses each into a separate file within a virtual file system in the ImHex editor.

<pre>
/*!
Deconstruct a Fury of the Furries DAT archive

Running this pattern will extract and decompress the archive into the Virtual Filesystem
*/

#pragma endian little
#pragma pattern_limit 2000000

import std.string;
import std.core;
import std.io;
import hex.core;
import type.base;

std::mem::Section currentSection;
s32 currentOffset = 0;

// Is the archived file compressed
enum Compressed : u8 {
Yes,
No
};

fn addSpace() {
u8 space[18] @ 0 in currentSection;
for (u8 i = 0, i < 18, i = i + 1) {
space[i] = 0x20;
}
};

// Copy a run length section from earlier in the compressed file
fn outputRunLengthCopy(auto length, auto offset) {
while (length > 0) {
std::mem::copy_section_to_section(currentSection, offset + 18, currentSection, currentOffset + 18, 1);
offset = offset + 1;
currentOffset = currentOffset + 1;
length = length - 1;
}
};

// A pair of bytes representing a run length
struct CompressionPair {
u16 shadowPair [[hidden, no_unique_address]];
u8 length = ((shadowPair >> 8) & 0x0f) + 3;
u16 offset = ((shadowPair >> 12) << 8) + (shadowPair & 0xff) + 18;
s32 fullOffset = offset + (currentOffset & 0xfffff000);
if (fullOffset >= currentOffset) {
fullOffset = fullOffset - 4096;
}
str comment = std::string::to_string(length) + " bytes @ " + type::impl::format_number(fullOffset, "0x{:02X}");

u16 pair [[comment(comment)]];

outputRunLengthCopy(length, fullOffset);
} [[inline]];

// A single byte literal
struct CompressionLiteral {
u8 byte;
} [[inline]];

// Either a single byte literal, or a run-length pair
struct CompressionItem {
u8 index = std::core::array_index();
u8 flag = (parent.flags >> index) & 0x01;
if (flag) {
CompressionLiteral byte;
std::mem::copy_value_to_section(byte, currentSection, currentOffset + 18);
currentOffset = currentOffset + 1;
}
else {
CompressionPair pair;
}
if ($ >= parent.parent.parent.end) {
break;
}
} [[inline]];

// A set up up to 8 compression items controlled by a flag bitfield
struct CompressionBlock {
u8 flags [[color("008800")]];
CompressionItem parts[8] [[inline]];
};

// A compressed data file
struct CompressedData {
CompressionBlock data[while($ < parent.end)];
} [[inline]];

// A single file within the archive
struct File {
char name[13] [[color("00ff00")]];
u32 uncompressedSize [[color("00ee00")]];
u32 compressedSize [[color("00dd00")]];

// create decompression section
Compressed isCompressed [[color("00cc00")]];
currentSection = std::mem::create_section(name);
std::mem::set_section_size(currentSection, uncompressedSize + 18);
addSpace();
u8 buffer[uncompressedSize] @ 18 in currentSection;
currentOffset = 0;

u32 end = $ + compressedSize;
if (isCompressed == 0) {
CompressedData compressedData [[color("000000")]];
}
else {
u8 data[compressedSize] [[color("000000")]];
std::mem::copy_value_to_section(data, currentSection, 18);
}
str fileName = std::string::to_string(name);
hex::core::add_virtual_file(fileName, buffer);
std::mem::delete_section(currentSection);
} [[name(name)]];

// A dat archive
struct Archive {
u16 fileCount [[color("ff0000"), name("Number of files")]];
File files[fileCount] [[inline]];
} [[inline]];

Archive archive @ 0x00;
</pre>

Fury of the Furries

2024-10-02T15:31:48Z

Carbon14: Document what looks like a bug in the data shipped by the developers

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

'''Fury of the Furries''' (also subsequently reskinned as '''Pac-In-Time''') is a puzzle-platform game for the PC, Macintosh, Amiga and Amiga-32, developed by [https://en.wikipedia.org/wiki/Kalisto_Entertainment Kalisto] and released by [https://en.wikipedia.org/wiki/Mindscape_(company) Mindscape] in 1993

== Obtaining the game ==

The game has not been officially released as freeware.

{{BeginGameFileList}}
{{GameFile
| Name = *.dat
| Format = [[DAT Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Archive collection of other files, used by either of the preliminary executables (intro.dat or lang.dat)
}}
{{GameFile
| Name = messages.*
| Format = [[MESSAGES Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Text strings in different languages
}}
{{GameFile
| Name = passw.dta
| Format = [[DTA Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Passwords used in the games cheat protection
}}
{{GameFile
| Name = prot.*
| Format = [[PROT Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Text strings in different languages for the cheat protection screen
}}
{{GameFile
| Name = lang.txt
| Format = [[LANG.TXT Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Selection of languages supported by the game
}}
{{GameFile
| Name = furies.anm
| Format = [[ANM Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Arrangement of icons on the screen during language selection
}}
{{GameFile
| Name = *.kmd
| Format = [[KMD Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Obscure MOD file music format
}}
{{GameFile
| Name = *.iff
| Format = [[AIFF Format]]
| KnownFormat = Yes
| Desc = Sound effect in AIFF format
}}
{{GameFile
| Name = spr/*.lbm
| Format = [[LBM Format]]
| KnownFormat = Yes
| Desc = 4-bit Image file contains player and enemy sprites
}}
{{GameFile
| Name = dec/*.lbm
| Format = [[LBM Format]]
| KnownFormat = Yes
| Desc = 4-bit Image file containing backgrounds for game levels
}}
{{GameFile
| Name = pic/*.lbm
| Format = [[LBM Format]]
| KnownFormat = Yes
| Desc = 16-bit Image file containing cut scene images
}}
{{GameFile
| Name = dat/data*.bin
| Format = [[BIN Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Game level data
}}
{{GameFile
| Name = dat/cdata*.bin
| Format = CDATA Format (Fury of the Furries)
| KnownFormat = No
| Desc = Unknown
}}
{{GameFile
| Name = dat/demo*.bin
| Format = [[DEMO Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Script for automatic playing of certain game levels in 'attract mode'
}}
{{GameFile
| Name = dat/fdata*.bin
| Format = FDATA Format (Fury of the Furries)
| KnownFormat = No
| Desc = Unknown
}}
{{GameFile
| Name = dat/gamedat.bin
| Format = [[GAMEDAT Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = User preference settings and save progress
}}
{{GameFile
| Name = dat/sdata*.bin
| Format = SDATA Format (Fury of the Furries)
| KnownFormat = No
| Desc = Unknown
}}
{{GameFile
| Name = *.blk
| Format = [[BLK Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Pixel ranges used to select sections of images
}}
{{GameFile
| Name = *.imm
| Format = [[IMM Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Pixel information for an image, but without a color palette
}}
{{GameFile
| Name = *.lmh
| Format = [[LMH LMO Format (Fury of the Furries)|LMH Format]]
| KnownFormat = Yes
| Desc = Part of an animation for the game intro
}}
{{GameFile
| Name = *.lmo
| Format = [[LMH LMO Format (Fury of the Furries)|LMO Format]]
| KnownFormat = Yes
| Desc = Part of an animation for the game intro
}}
{{GameFile
| Name = *.pam
| Format = [[VGA Palette]] (modern form)
| KnownFormat = Yes
| Desc = Palette information for images
}}
{{GameFile
| Name = *.snd
| Format = [[SND Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Sound effects used in the game intro
}}
{{EndGameFileList}}

== Oddities ==

The file KAL.SND in the INTRO.DAT archive seems to be faulty. In general the SND files mostly contain just a sound wave form as you would find in the SSND chunk of an [[AIFF Format]] file. However, here the data seems to contain almost (but not quite) an entire AIFF file. It looks as though the developers would create sounds as AIFF files, and then extract the wave data to pack into the SND files, and here they have mistakenly taken more than they should have into that file. If this is indeed a mistake then the result would be a very short burst of noise at the beginning of the sample (coming from the AIFF header mistakenly included) and a slight truncation of the intended sample, with the bulk of the sample sounding correct.

== Links ==

* [https://github.com/david-c14/FuryStudio/blob/v0.4.1-dev/doc/reference/index.md A developing hypertext reference for the behaviour of the game engine]

== Notes ==

[[Category:Mindscape]]
[[Category:Puzzle-Platformer]]

LZEXE

2024-08-01T14:25:25Z

Carbon14: Link to explanation of the algorithm and decompressor

{{Tool Infobox
| Platform = MS-DOS
| Release = 1989
| Homepage = [https://bellard.org/lzexe.html bellard.org]
| Download = See homepage
| Edit1 = Extraction 
| Games = N/A
}}

'''LZEXE''' is a utility that compresses an executable file into a smaller, self-extracting form. It was used in most early [[:Category:id Software|id Software]] and [[:Category:Apogee|Apogee]] games, and many others. LZEXE compressed executables can be unpacked by a few different utilities, the most widely used being [[UNLZEXE]].

An LZEXE compressed executable can be recognized by the presence of the tag "LZ" at offset 0x1C in the .EXE file, followed by a version number that is either "09" or "91". Such executables must be decompressed before any useful inspection or hacking of the .EXE can take place.

Note that some programs change the LZ91 signature to disguise the fact that LZEXE has been used. If there are four sensible-looking characters at the same offset there's a good chance the file has been compressed with LZEXE and had its signature changed. Luckily most decompression utilities don't look at this so they can decompress the file anyway. UNLZEXE looks at the .exe entry point where the decompression routine sits, and compares this to known LZEXE decompressors to identify the version.

There are three known variants of LZEXE:

* Version 0.90: First release, supported by most decompressors.
* Version 0.91: Most popular release, supported by most decompressors.
* Version 0.91e: Latest version available, but still listed as version 0.91. It is referred here as 0.91e as this is one of the download links on the author's website. The decompression code in this version contains two very small changes which prevents UNLZEXE from recognising it. Support for decompressing this version has been added to [https://github.com/Malvineous/gamecompjs/blob/master/compress/cmp-lzexe.js Camoto's gamecompjs]. The actual compression algorithm has not changed from 0.91 so supporting this variant merely requires detecting the altered decompression routine.

== Links ==

* [https://cosmodoc.org/topics/lzexe/ A comprehensive breakdown of the decompression process by Scott Smitelli]

[[Category:Compression algorithms]]

Talk:BGI Stroked Font

2023-12-21T08:26:50Z

Carbon14: /* character layout */

= character layout =
The numbers in the description and diagram include 64, and for the above the baseline it ranges from 0 to 64, which is too large a range for a 6-bit number. Do we know enough detail to clarify the range, and to determine if the negative values are simply signed or 2s complement? [[User:Carbon14|Carbon14]] ([[User talk:Carbon14|talk]]) 08:26, 21 December 2023 (GMT)

: Looking at the FreeBASIC code, it looks as though the X values is simply signed, and has a range from -63 to +63 with both -ve and +ve 0; while the Y value is a 2s complement with a range of -64 to 63. [[User:Carbon14|Carbon14]] ([[User talk:Carbon14|talk]]) 08:26, 21 December 2023 (GMT)

Talk:BGI Stroked Font

2023-12-21T08:11:16Z

Carbon14: question about co-ordinate encoding

BGI Stroked Font

2023-12-21T08:05:02Z

Carbon14: Correct typo, and correct 5-bit to 6-bit number in X Y bytes

{{Font Infobox
| MaxGlyphs = 32,767
| GlyphMinSize = Unlimited
| GlyphMaxSize = Unlimited
| Access = Indexed
| Bitmap = N
| Vector = Y
| Compressed = N
| Hidden = Y
| Metadata = ID, Description
| Games =
}}

A '''BGI Stroked Font''' is a vector font created by Borland to work with their 1987 graphics API, [[Borland Graphics Interface]]. Since the format stores vector fonts, it can easily be scaled in size with little loss of fidelity. However, because the format only supports lines and not curves, scaling to larger sizes will make the characters look jagged. The font files typically have a *.CHR file extension.

After 1987, Borland's C and Pascal programming languages shipped with 10 different BGI Stroked Fonts: Bold, Euro, Goth, Lcom, Litt, Sans, Scri, Simp, Trip, and Tscr. Due to the popularity of Borland's programming languages, and their graphic API, BGI Stroked Fonts were used in hundreds of DOS video games.

The designers of the file format unfortunately used a file signature starting with "PK" which would later be used by PK Zip, so BGI Stroked Font files, despite having an extension of CHR, might be misidentified as zip archives if the identifier doesn't take into account the full PK Zip signature.

== Format ==
=== Header ===
The header includes the font's id, version number, and description.

{| class="wikitable"
! Data Type !! Name !! Description
|-
| [[char]][4] || Signature || Must be 0x50 0x4B 0x08 0x08.
|-
| [[char]][...] || Description || User text. Borland's official fonts start with "BGI Stroked Font", then the version number, and ends with a copyright. The description is terminated with: 0x1A.
|-
| [[INT16LE]] || Header Size || The size, in bytes, of the entire header.
|-
| [[char]][4] || Font Id || a 4-character id of the font.
|-
| [[INT16LE]] || Data Size || The size of the font's data block. The Header Size + Data Size should be the size of the file.
|-
| [[INT16LE]] || Major Version Number || The major version number of the font format.
|-
| [[INT16LE]] || Minor Version Number || The minor version number of the font format.
|-
| Nulls || Padding || The rest of the header should be padded out to nulls based on the Header Size. All official Borland fonts use a header size of 0x80.
|}

=== Stroke Header ===
This section contains general information about the font including how many characters are represented, the top of the highest ascender, bottom of the lowest descender, baseline, where in the file to find each character's instructions, and the width of each character.

{| class="wikitable"
! Data Type !! Name !! Description
|-
| [[char]] || Stroke Check || A value of 0x2B indicates this is a stroked font.
|-
| [[INT16LE]] || Character Count || Number of total characters stored in this font.
|-
| [[BYTE]] || Undefined || Borland's own documentation labels this as "undefined."
|-
| [[INT8]] || Starting Character || The index of the first character to have a glyph associated with it.
|-
| [[INT16LE]] || Strokes Offset || The file offset where stroke definitions begin.
|-
| [[BYTE]] || Scan Flag || {{TODO|Borland's documentation calls this the "scan flag," but doesn't explain what it is for.}}
|-
| [[INT8]] || Origin to Ascender || The distance from the origin to the font's highest point.
|-
| [[INT8]] || Origin to Baseline || The distance from the origin to the font's baseline (typically 0).
|-
| [[INT8]] || Origin to Descender || The distance from the origin to the font's lowest point. Note, you can derive the total character height by getting the distance from the Ascender to Descender.
|-
| Nulls || Padding || This section is padded with nulls until you get to the Strokes Offset. All official Borland fonts pad this section to 0x10 bytes.
|-
| [[INT16LE]][Character Count] || Character Stroke Offsets || An array of the offset to the stroke definitions for each character. To get the position in the file, you must add the Header Size and the Strokes Offset to this value.
|-
| [[INT8]][Character Count] || Character Widths || The unscaled width of each character.
|-
| Stroke Data || Character strokes || The stroke instructions for each character. See below for how to interpret them.
|}

=== Stroke Data ===
This section contains the actual instructions for drawing individual characters.

{| class="wikitable"
! Data Type !! Name !! Description
|-
| [[BYTE]] || X Instruction || Instructions for drawing the character and an X value.
|-
| [[BYTE]] || Y Instruction || Instructions for drawing the character and a Y value.
|-
| ... || Several possible instruction pairs per character.
|}

Encoded in each two byte pair is a single stroke instruction, and an X and Y value. The most-significant bit in each byte is an opcode, the next seven bits represent a signed value. The first byte is the X value, the second byte is the Y value. See the diagram below.

7 6 543210
^ ^ ^
| | +----------- 6-Bit number.
| +------------- Sign bit for number.
+--------------- Opcode.

The two opcodes determine the instruction.

{| class="wikitable"
! Code 1 !! Code 2 !! Instruction
|-
| 0 || 0 || End of character stroke definition.
|-
| 0 || 1 || Borland's documentation has this labeled as "do scan," implying it's related to the Scan Flag. It's only used in their BOLD font on characters with multiple objects like the colon and equals sign. It doesn't appear to affect how the character is drawn. {{TODO|More info is needed.}}
|-
| 1 || 0 || Move plotter to the specified X and Y coordinates.
|-
| 1 || 1 || Draw a line from the previous X and Y coordinates and move plotter to the new X and Y coordinates.
|}

== Character Layout ==
[[Image:BGI Stroked Font - Layout Diagram.png|thumb|256x256px|Y-axis layout.]]
The Y values for each character are stored in a unique manner. Characters are drawn relative to the baseline, but, rather than put the baseline at 0, the half above the baseline starts at 64 and decreases toward 0 as you move away from the baseline, while the half below the baseline starts at -64 and increases toward -1. See the diagram to the right.

== Source Code ==
=== Shape Viewer ===
This FreeBASIC program will draw all of the characters in the specified font, and give details about the font.

<syntaxhighlight lang="freebasic">
ScreenRes 1000, 800, 32

' Open the font file.
Open "SANS.CHR" For Binary As #1

' Verify the signature.
Dim As String Check
Check = Space(4)
Get #1, , Check
If Check <> "PK" + Chr(8) + Chr(8) Then
Print "Not a Borland CHR font."
End
End If

' Load the Description
Dim As UByte Buffer
Dim As String Description
Do
Get #1, , Buffer
If Buffer <> &h1A Then
Description = Description + Chr(Buffer)
End If
Loop Until Buffer = &h1A

' Load the header size.
Dim As UShort HeaderSize
Get #1, , HeaderSize

' Load the font id.
Dim As String FontId
FontId = Space(4)
Get #1, , FontId

' Load the data file size. (HeaderSize + DataSize should match the size of the file.)
Dim As UShort DataSize
Get #1, , DataSize

' Load the font version number.
Dim As UShort FontMajorVersion
Get #1, , FontMajorVersion
Dim As UShort FontMinorVersion
Get #1, , FontMinorVersion

' Jump to the end of the header. The rest should be nulls anyway.
Get #1, HeaderSize, Buffer

' Verify this is a BGI Stroked Font.
Dim As String StrokedFontCheck
StrokedFontCheck = Space(1)
Get #1, , StrokedFontCheck
If StrokedFontCheck <> "+" Then
Print "Not a stroked font."
End
End If

' Load the number of characters.
Dim As UShort CharacterCount
Get #1, , CharacterCount

' Skip an unknown byte.
Get #1, , Buffer

' Load the starting charcter. This is the first character id to have a glyph associated to it.
Dim As UByte StartingChar
Get #1, , StartingChar

' Load the file offset where the stroke definitions begin.
Dim As UShort StrokeDefinitionOffset
Get #1, , StrokeDefinitionOffset

' Skip an unknown byte.
Get #1, , Buffer

' Load the distance from the origin to the top of the capital letters.
Dim As Byte OriginToCapital
Get #1, , OriginToCapital

' Load the distance from the origin to the baseline.
Dim As Byte OriginToBaseline
Get #1, , OriginToBaseline

' Load the distance from the origin to the bottom of the descenders.
Dim As Byte OriginToDescender
Get #1, , OriginToDescender

' Skip remaining nulls.
Dim As Integer I
For I = 0 To 4
Get #1, , Buffer
Next I

' Load offset to characters definitions.
Dim As UShort CharacterDefinitionOffset(StartingChar To (StartingChar + CharacterCount) - 1)
For I = StartingChar To (StartingChar + CharacterCount) - 1
Get #1, , CharacterDefinitionOffset(I)
Next I

' Load character widths.
Dim As UByte CharacterWidths(StartingChar To (StartingChar + CharacterCount) - 1)
For I = StartingChar To (StartingChar + CharacterCount) - 1
Get #1, , CharacterWidths(I)
Next I

Dim As Integer CharacterHeight = OriginToCapital + (OriginToDescender * -1)

Print "Font Id: "; FontId
Print "Description: "; Description
Print "Total Character Height: "; CharacterHeight
Print "Max Ascender: "; OriginToCapital
Print "Max Descender: "; OriginToDescender
Print "Total Characters: "; CharacterCount
Print "Starting Character: 0x"; Hex(StartingChar)

Dim As UByte XByte, YByte, Finished
Dim As Integer XCurrent, YCurrent, XStart, YStart, XBuffer, YBuffer
Dim As Byte XNew, YNew, XOpcode, YOpcode, XSign, YSign

XStart = 10
YStart = 130
XBuffer = 5
YBuffer = 10

For I = StartingChar To (CharacterCount - StartingChar) - 1
' Jump to the starting offset of this character.
Get #1, CharacterDefinitionOffset(I) + StrokeDefinitionOffset + HeaderSize, Buffer

' Load all of the drawing instructions and draw the character.
Finished = 0
Do
' Load the opcode/values. Two bytes, one for X, the other for Y.
' 7 6 543210
' ^ ^ ^
' | | +------ Start of 6-bit number.
' | +-------- Sign bit for number.
' +---------- Opcode bit.

Get #1, , XByte ' First opcode and X value.
Get #1, , YByte ' Second opcode and Y value.

' Read the opcode and sign bits.
XOpcode = Bit(XByte, 7)
YOpcode = Bit(YByte, 7)
XSign = Bit(XByte, 6)
YSign = Bit(YByte, 6)

' Clear the opcode bits and the sign bits.
XByte = BitReset(XByte, 7)
XByte = BitReset(XByte, 6)
YByte = BitReset(YByte, 7)
YByte = BitReset(YByte, 6)

XNew = XByte
YNew = YByte

' Set the values to negative if the signed bits are on.
If XSign = True Then
XNew = XNew * -1
End If
If YSign = True Then
YNew = (64 - YNew) ' Normalize the descender's value.
YNew = YNew * -1
End If

' Normalize the Y position.
YNew = (64 - YNew)

If XOpcode = 0 Then
If YOpcode = 0 Then
' End of character definition. Move to the next character.
XStart = XStart + CharacterWidths(I) + XBuffer
If XStart > 950 Then
XStart = 10
YStart = YStart + CharacterHeight + YBuffer
End If
Finished = 1
Else
' Not sure what this is for. It's only used in the BOLD font when a character has
' multiple separate objects like with the colon and equal sign. However, not all
' characters with broken up objects in the font use it, and leaving it out doesn't
' appear to mess up the drawing at all.
End If
Else
If YOpcode = 0 Then
' Move Pointer to X, Y.
' This happens below since both move and draw must change the position.
Else
' Draw From Current Pointer to new X, Y.
Line(XCurrent, YCurrent)-(XStart + XNew, YStart + YNew), RGB(255, 255, 255)
End If

XCurrent = XStart + XNew
YCurrent = YStart + YNew
End If
Loop Until Finished = 1
Next I

Sleep
</syntaxhighlight>

== Tools ==
{{BeginFileFormatTools|Type=image}}
{{FileFormatTool
| Name = [https://ftp.sunet.se/mirror/archive/ftp.sunet.se/pub/simtelnet/msdos/borland/bgifont.zip FE Stroke Font Editor]
| Platform = DOS
| canView = Yes
| canExport = Yes
| canImport = Yes
| editHidden = No
| editMetadata = Yes
| notes = Borland's in-house font Stroked Font editor.
}}
{{EndFileFormatTools}}

== Credits ==
This format was reverse engineered by [[User:TheAlmightyGuru|TheAlmightyGuru]]. 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!)

== Links ==
* [https://ftp.sunet.se/mirror/archive/ftp.sunet.se/pub/simtelnet/msdos/borland ftp.sunet.se/mirror/archive/ftp.sunet.se/pub/simtelnet/msdos/borland] - Various tools for BGI fonts.

DAT Format

2023-10-16T14:56:25Z

Carbon14: Added Fury of the Furries

{{Disambig}}

The ''DAT Format'' could mean:

* [[DAT Format (Bullfrog)]]
* [[DAT Format (California Games II)]]
* [[DAT Format (Dr. Riptide)]]
* [[DAT Format (Dark Legions)]]
* [[DAT Format (Fury of the Furries)]]
* [[DAT Format (God of Thunder)]]
* [[DAT Format (Highway Hunter)]]
* [[DAT Format (Hocus Pocus)]]
* [[DAT Format (Hugo)]]
* [[DAT Format (Monster Bash)]]
* [[DAT Format (Mystic Towers)]]
* [[DAT Format (Papyrus)]]
* [[DAT Format (Sango Fighter)]]
* [[DAT Format (The Lost Vikings)]]
* [[DAT Format (Wacky Wheels)]]
* [[DAT Format (Witchaven savegame)]]
* [[DAT Format (Zool)]]
* [[DAT Format (ZZT)]]

BIN Format (Fury of the Furries)

2023-09-08T15:06:06Z

Carbon14: /* FILE Format */ Confirm starting position of player sprite

{{Map Infobox
| Type = 2D tile-based
| Layers = 3
| Tile size = 16×16
| Viewport = 320×200
| Games =
{{Game|Fury of the Furries}}
{{Game|Pac-In-Time}}
}}

[[Fury of the Furries]] maps contain the static background and landscape for the level, collectable coins, time extensions and extra lives and destructible bricks. They also contain the 'scripting for the game play itself', this is in the form of the definitions of the sprites that interact with the player character. There are up to 10 sprites in the level, each having up to 10 states. Triggers are defined for switching between states, and for the player and or sprites to switch on or off other game-play elements.

The file itself is run-length encoded, and after decompression is always a fixed length. Generally unused elements within the game are marked by the [[UINT16LE]] value 0xFFFF.

== File Formats ==

=== RLE Compressed File Format ===

{|class="wikitable"
! Data Type || Name || Description
|-
| FOURCC || header || Appears to be a header with version number. Most files decompress to an object 25518 bytes in length, but a handful of files are shorter, and appear to be earlier versions. 
byte is the shortest, at 25432 bytes, the last entry is the time field. 
byt1 and byt3 are 25482 bytes long, and include currents. 
byt4 is 25518, it's the version seen for the vast majority of the files, and includes all the fields after the currents.
|-
| [[UINT16LE]] || length || Number of bytes in section. 
if zero then stop decompressing. 
if less than 0x7D00 then use the following length bytes from the input. 
otherwise use the following byte from the input (length - 0x7D00) times. 
 
compressed and uncompressed sections always alternate, even if this makes the packing less efficient. This means that if you have two adjacent runs, There will be at least 1 character represented as uncompressed.
|-
| ... || etc || continue with another 'length' until the final file size is achieved (25,518 bytes), or you read a 0 length.
|}

The file should end with a zero length section. i.e. two bytes of 0.

=== Uncompressed File Format ===

==== FILE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || mapWidth || Width of the playable area (in tiles) between 20 and 78.
|-
| [[UINT16LE]] || mapHeight || Height of the playable area (in tiles) between 13 and 51.

The maximum number of tiles in a game is 1024. This places constraints on the width and height.
The minimum width is 20 to match the viewport size of 320 pixels, and this constrains the height to 51 (20 × 51 = 1020).
The minimum height is 13 to match the viewport size of 200 pixels, and this constrains the width to 78 (13 × 78 = 1014).
Any other combination of width and height is possible so long as it meets these constraints.
|-
| [[UINT8]][2][78 × 51] || tileIndex || Pairs of coordinates into a [[LBM Format]] <tt>DEC</tt> file containing the tiles.
|-
| [[UINT16LE]] || decFile || The <tt>DEC</tt> file number less one. i.e. a value of 3 indicates <tt>DECOR04.LBM</tt>.
|-
| [[UINT16LE]] || startLeft || The center of the starting position for the player character from the left of the level, less 16 pixels.
|-
| [[UINT16LE]] || startTop || The center of starting position for the player character from the top of the level, less 16 pixels.
|-
| [[UINT16LE]] || foregroundPaletteIndex || The index of the first palette entry to be regarded as foreground.

The palette for the <tt>DEC</tt> file has 16 colours and they are used in a particular order. The first is always black and is background (i.e. the player character is not blocked by this colour)
The next 4 usually dark versions of yellow, red, green and blue and are used for the shadow colour of the player character sprite, in the 4 different forms that the player can take.
The next colour (colour 5 in the palette) is the bright colour of the player character, and will be swapped out as the player changes form.
The remaining colours a chosen to suit the needs of the stage of the game (desert, forest, mountains etc).
Generally the lower colours are regarded as background, and the upper colours as foreground, and this is used in the collision detection for the player and the landscape.
|-
| EXIT[5] || exit || 5 instances of a 6-byte structure describing the exits from the level.
|-
| WATER[5] || water1 || 5 instances of an 8-byte structure describing the regions of water in the level.
|-
| TELEPORT[5] || teleport || 5 instances of an 8-byte structure describing the regions of the game that can teleport the player.
|-
| NONSTICK[5] || nonStick || 5 instances of an 8-byte structure describing regions that the player cannot attach a rope to.
|-
| ACID[5] || acid || 5 instances of an 8-byte structure describing regions that will dissolve the player if touched.
|-
| DANGER[20] || danger || 20 instances of an 8-byte structure describing regions that will explode the player if touched.
|-
| SPRITE[10] || sprite || 10 instances of a 1688-byte structure describing sprites.
|-
| [[UINT16LE]] || blueStart || 1 if the blue form of the player is available at the start of the game.
|-
| [[UINT16LE]] || greenStart || 1 if the green form of the player is available at the start of the game.
|-
| [[UINT16LE]] || redStart || 1 if the red form of the player is available at the start of the game.
|-
| [[UINT16LE]] || yellowStart || 1 if the yellow form of the player is available at the start of the game.
|-
| [[UINT8]][12] || unknown || Purpose unknown.
|-
| FIELD[5] || redField || 5 instances of an 8-byte structure describing the particle field that enables/disables the red form of the player.
|-
| FIELD[5] || greenField || 5 instances of an 8-byte structure describing the particle field that enables/disables the green form of the player.
|-
| FIELD[5] || yellowField || 5 instances of an 8-byte structure describing the particle field that enables/disables the yellow form of the player.
|-
| FIELD[5] || blueField || 5 instances of an 8-byte structure describing the particle field that enables/disables the blue form of the player.
|-
| WATER[5] || water2 || 5 further instances of an 8-byte structure describing the regions of water in the level.

Probably one of these 2 sets of water data describes regions that start full of water and can be emptied, and the others describe regions which start empty and can be filled. I'm not sure.
|-
| [[UINT8]][10] || unknown || Purpose unknown.
|-
| [[UINT8]] || waterPaletteIndex || Index of colour in palette used for water.
|-
| [[UINT8]] || airPaletteIndex || Index of colour in palette used for air.

These two palette entries can be used to modify the image as regions of water fill/empty.
|-
| [[UINT16LE]] || time || Amount of time the player has to complete the level. In 30ths of a second (The game plays at 30 fps).
|-
| CURRENT[5] || current || 5 instances of a 10-byte structure describing regions of air or water currents.
|-
| [[UINT8]] || motePaletteIndex || Index of colour in palette used for dust motes moving in currents.
|-
| [[UINT8]] || unknown || Purpose unknown.
|-
| [[UINT16LE]] || spriteMap || Index of [[LBM Format]] <tt>SPR</tt> sprite map image to use for this level. 0 = A, 1 = B.
|-
| EXITRETURN[5] || exitReturn || 5 instances of a 4-byte structure describing where the player character should re-enter the level following a side-quest.
|-
| [[UINT16LE]][5] || exitGraphic || 5 instances of and indication of how a player is depicted exiting. 0 used for the end of the level dissolves the level viewport in a swirling vortex. 1 is smooth and is used for tunnelling in multi-map levels.
|-
| [[UINT16LE]] || unknown || Seems to indicate a row in the map at which some odd palette behaviour is observed. Possibly a bug, but it could be that the intention is to shift something in the colour scheme when the player is above ground / below ground.
|}

==== EXIT Format ====

The exit region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the exit.
|-
| [[UINT16LE]] || top || top pixel of the centre of the exit.
|-
| [[UINT16LE]] || destination || Level number less one to go to next from this exit. Also the most significant bit indicates 0 = level exit, 1 = go to side quest. 
e.g. if this value is 0x8006, then go to level 7 as a side-quest.
|}

==== WATER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the water region.
|-
| [[UINT16LE]] || top || Top pixel of the water region.
|-
| [[UINT16LE]] || right || Right pixel of the water region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the water region.
|}

==== TELEPORT Format ====

The teleport region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || srcX || Left pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || srcY || Top pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destX || Right pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destY || Bottom pixel of the centre of the teleport region.
|}

==== NONSTICK Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the non-stick region.
|-
| [[UINT16LE]] || top || Top pixel of the non-stick region.
|-
| [[UINT16LE]] || right || Right pixel of the non-stick region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the non-stick region.
|}

==== ACID Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the acid region.
|-
| [[UINT16LE]] || top || Top pixel of the acid region.
|-
| [[UINT16LE]] || right || Right pixel of the acid region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the acid region.
|}

==== DANGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the danger region.
|-
| [[UINT16LE]] || top || Top pixel of the danger region.
|-
| [[UINT16LE]] || right || Right pixel of the danger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the danger region.
|}

==== FIELD Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the particle field.
|-
| [[UINT16LE]] || top || Top pixel of the particle field.
|-
| [[UINT16LE]] || right || Right pixel of the particle field.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the particle field.
|}

==== CURRENT Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the current region.
|-
| [[UINT16LE]] || top || Top pixel of the current region.
|-
| [[UINT16LE]] || right || Right pixel of the current region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the current region.
|-
| [[UINT16LE]] || flags || bit-0 and bit-1 : direction 00 = down, 01 = right, 10 = up, 11 = left bit-2: strength of current 0 = weak, 1 = strong bit-3: show current using dust motes 0 = no, 1 = yes
|}

==== EXITRETURN Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the return region.
|-
| [[UINT16LE]] || top || Top pixel of the return region.
|}

==== REGION Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left of region
|-
| [[UINT16LE]] || top || Top of region
|-
| [[UINT16LE]] || right || Right of region
|-
| [[UINT16LE]] || bottom || Bottom of region
|}

==== SPRITE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT8]] || layer || 0 = middleground (can interact with the player) 1=background 2=foreground (player can move behind it).
|-
| [[UINT8]] || malevolence || Bit-0: sprite will kill player in ? form Bit-1: sprite will kill player in yellow form Bit-2: sprite will kill player in ? form Bit-3: sprite will kill player in ? form.
|-
| [[UINT16LE]] || unknown || Purpose unknown
|-
| [[UINT16LE]] || mask || Sprite requires a mask graphic for transparency. If a mask is required, it will be immediately below the sprite tile in the <tt>SPR</tt> file.
|-
| [[UINT16LE]] || cleanUp || The previous sprite image needs to be removed for each frame. This is not necessary if the sprite is unmasked and never changes position.
|-
| [[UINT16LE]] || strength || How much damage the sprite can sustain. 0 = infinite, otherwise 1-127.
|-
| [[UINT16LE]] || blastArea || Size of the explosion if the sprite is destroyed. (Purely a decorative concern, there is no splash damage).
|-
| [[UINT16LE]] || active || Is the sprite in use.
|-
| [[UINT8]][2] || unknown ||
|-
| REGION || furryEntryRegion || Sprite will activate if furry enters this region.
|-
| REGION || furryExitRegion || Sprite will activate if furry leaves this region.
|-
| [[UINT8]][72] || unknown || Suspect that this region is actually populated and used as working space while the level is being played.
|-
| [[UINT16LE]] || fireRate || How often the sprite fires projectiles. 0 = none, 1-5 = low-high.
|-
| [[UINT16LE]] || fireType || How are projectiles fired. 1 = All directions slowly, 2 = Right, 3 = Left, 4 = All directions medium, 5 = All directions fast.
|-
| STATE[10] || state || 10 instances of a 158-byte structure describing the states that the sprite can be in.
|}

==== STATE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite location.
|-
| [[UINT16LE]] || top || Top pixel of the sprite location.
|-
| [[UINT16LE]] || destState || Another state to move towards. The sprite will physically move to the location of the destination state, and change state when it reaches that location.
|-
| [[UINT16LE]] || speed || Speed of sprite movement 0 = None, 1-5 = slow-fast.
|-
| [[UINT8]] || movementType || 0 = horizontal then vertical, 1 = as the crow flies, 2 = just track player vertically, no sideways movement, 3 = just track player horizontally, no up/down movement, 4 = track player, 5 = fast move??, 6 = None.
|-
| [[UINT8]] || destWaterState || Another state to change to when a requested water level change is acheived.
|-
| [[UINT8]] || gravity || If 1, the sprite falls when unsupported.
|-
| [[UINT8]] || current || Control currents. Bits 0-4 specify currents affected, Bit-5 turns currents off, Bit-6 turns currents on.
|-
| [[UINT16LE]] || activateSprite || Number of another sprite to activate.
|-
| TRIGGER || entryTrigger || A 10-byte structure that describes a trigger to change state when the player enters a region.
|-
| TRIGGER || exitTrigger || A 10-byte structure that describes a trigger to change state when the player leaves a region.
|-
| TRIGGER || spriteEntryTrigger || A 10-byte structure that describes a trigger to change state when another sprite enters a region.
|-
| TRIGGER || spriteExitTrigger || A 10-byte structure that describes a trigger to change state when another sprite leaves a region (or is destroyed).
|-
| [[UINT8]] || destroy || The sprite is destroyed (deactivated) when it enters this state.
|-
| [[UINT8]] || bounce || The sprite bounces ballistically when it hits a surface.
|-
| [[UINT16LE]] || emptyWater || Bits 8-15 speed of emptying, Bits 0-7 number of water region to empty.
|-
| [[UINT16LE]] || fillWater || Bits 8-15 speed of filling, Bits 0-7 number of water region to fill.
|-
| [[UINT8]][4] || unknown || Seems to affect the starting location of projectiles, relative to the sprite location.
|-
| [[UINT16LE]] || waterTriggerLeft || Left pixel of region for water trigger (see destWaterState field).
|-
| [[UINT16LE]] || waterTriggerTop || Top pixel of region for water trigger.
|-
| [[UINT16LE]] || waterTriggerRight || Right pixel of region for water trigger.
|-
| FRAME[10] || frame || 10 instances of an 8-byte structure describing the sprite tile location within the <tt>SPR</tt> image file
|-
| [[UINT16LE]] || animSpeed || Rate of frame change of sprite animation.
|-
| [[UINT16LE]] || cycle || Does the animation cycle repeat.
|-
| [[UINT8]] || cycleCount || Number of animation frames before changing state.
|-
| [[UINT8]] || animTriggerState || Sprite state to move to when cycleCount is reached.
|-
| [[UINT16LE]] || waterTriggerBottom || Bottom pixel of region for water trigger.
|}

==== TRIGGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || state || State to move to when triggered.
|-
| [[UINT16LE]] || left || Left pixel of the trigger region.
|-
| [[UINT16LE]] || top || Top pixel of the trigger region.
|-
| [[UINT16LE]] || right || Right pixel of the trigger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the trigger region.
|}

==== FRAME Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || top || Top pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || right || Right pixel of the sprite on the <tt>SPR</tt> image file + 8 pixels.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the sprite on the <tt>SPR</tt> image file.
|}

== Notes ==

There are 10 different stages in the game, and correspondingly 10 different tile and sprite sets.

The tile images for the backgrounds and landscape are stored in the <tt>DEC</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>DECORxx.LBM</tt> where xx is specified by the decFile field of the main structure.

The sprite images are stored in the <tt>SPR</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>SPRxxn</tt> where xx is specified by the decFile field of the main structure, and n is specified by the spriteMap field in the main structure.

The sprites can be of varying sizes, the FRAME data structure describes the bounding box in pixels within the sprite image file. If the sprite requires a transparency mask, then this mask will be a rectangular region with the same size as the sprite, and placed in the image file immediately below the sprite.

Within the tile image file, all the tiles are 16 × 16 pixels, tiles are referenced in the main file structure as a pair of byte coordinates, giving the X and Y position in tiles within the image file.

Certain tiles in the image file have special meaning.

The tile at 0,1 is a coin. If the player touches this tile in the level, they will gain a coin, and the tile will be swapped out for the tile at 0,0 which is always empty.

The tile at 0,2 is an extra life. If the player touches this tile in the level, they will gain an extra life, and the tile will be swapped out for the tile at 0,0.

The tile at 0,3 is a time extension. If the player touches this tile in the level, they will gain an extra 30 seconds on the clock, and the tile will be swapped out for the tile at 0,0.

All the remaining tiles on rows 0, 1 and 2 in the map are destructible tiles. The red form of the player can chew through the scenery. Chewing a tile from row 0 will cause that tile to be swapped out with the tile immediately below it in row 1. Chewing a tile from row 1 will cause that tile to be swapped out with the tile immediately below it in row 2. Chewing a tile from row 2 will cause that tile to be swapped out with the tile at 0,0, which is empty, so the player can then get through the gap created. Typically the tiles in these rows depict a gradually degraded state, you can have tiles that require more or less action to destroy them, by choosing from the three rows. Often the top row tiles are visually indistinguishable from some other non-destructible tiles in the tileset, allowing you to hide destructible tiles.

== Tools ==

{{BeginFileFormatTools|Type=group}}
{{FileFormatTool
| Name = [[FuryUtils]]
| Platform = x64Windows, Linux
| canExtract = Yes
| canDecompress = Yes
| canCreate = Yes
| canModify = Yes
| canCompress = Yes
| editHidden = N/A
| editMetadata = Yes
| notes =
}}
{{EndFileFormatTools}}

== Credits ==

This file format was reverse engineered by [[User:Carbon14|carbon14]]. 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!)

BIN Format (Fury of the Furries)

2023-09-08T15:03:49Z

Carbon14: /* FRAME Format */ Note that frame boundary extends by an additional 8 pixels at the right

{{Map Infobox
| Type = 2D tile-based
| Layers = 3
| Tile size = 16×16
| Viewport = 320×200
| Games =
{{Game|Fury of the Furries}}
{{Game|Pac-In-Time}}
}}

[[Fury of the Furries]] maps contain the static background and landscape for the level, collectable coins, time extensions and extra lives and destructible bricks. They also contain the 'scripting for the game play itself', this is in the form of the definitions of the sprites that interact with the player character. There are up to 10 sprites in the level, each having up to 10 states. Triggers are defined for switching between states, and for the player and or sprites to switch on or off other game-play elements.

The file itself is run-length encoded, and after decompression is always a fixed length. Generally unused elements within the game are marked by the [[UINT16LE]] value 0xFFFF.

== File Formats ==

=== RLE Compressed File Format ===

{|class="wikitable"
! Data Type || Name || Description
|-
| FOURCC || header || Appears to be a header with version number. Most files decompress to an object 25518 bytes in length, but a handful of files are shorter, and appear to be earlier versions. 
byte is the shortest, at 25432 bytes, the last entry is the time field. 
byt1 and byt3 are 25482 bytes long, and include currents. 
byt4 is 25518, it's the version seen for the vast majority of the files, and includes all the fields after the currents.
|-
| [[UINT16LE]] || length || Number of bytes in section. 
if zero then stop decompressing. 
if less than 0x7D00 then use the following length bytes from the input. 
otherwise use the following byte from the input (length - 0x7D00) times. 
 
compressed and uncompressed sections always alternate, even if this makes the packing less efficient. This means that if you have two adjacent runs, There will be at least 1 character represented as uncompressed.
|-
| ... || etc || continue with another 'length' until the final file size is achieved (25,518 bytes), or you read a 0 length.
|}

The file should end with a zero length section. i.e. two bytes of 0.

=== Uncompressed File Format ===

==== FILE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || mapWidth || Width of the playable area (in tiles) between 20 and 78.
|-
| [[UINT16LE]] || mapHeight || Height of the playable area (in tiles) between 13 and 51.

The maximum number of tiles in a game is 1024. This places constraints on the width and height.
The minimum width is 20 to match the viewport size of 320 pixels, and this constrains the height to 51 (20 × 51 = 1020).
The minimum height is 13 to match the viewport size of 200 pixels, and this constrains the width to 78 (13 × 78 = 1014).
Any other combination of width and height is possible so long as it meets these constraints.
|-
| [[UINT8]][2][78 × 51] || tileIndex || Pairs of coordinates into a [[LBM Format]] <tt>DEC</tt> file containing the tiles.
|-
| [[UINT16LE]] || decFile || The <tt>DEC</tt> file number less one. i.e. a value of 3 indicates <tt>DECOR04.LBM</tt>.
|-
| [[UINT16LE]] || startLeft || The left of the starting position for the player character, less 8 pixels.
|-
| [[UINT16LE]] || startTop || The top of the starting position for the player character.
|-
| [[UINT16LE]] || foregroundPaletteIndex || The index of the first palette entry to be regarded as foreground.

The palette for the <tt>DEC</tt> file has 16 colours and they are used in a particular order. The first is always black and is background (i.e. the player character is not blocked by this colour)
The next 4 usually dark versions of yellow, red, green and blue and are used for the shadow colour of the player character sprite, in the 4 different forms that the player can take.
The next colour (colour 5 in the palette) is the bright colour of the player character, and will be swapped out as the player changes form.
The remaining colours a chosen to suit the needs of the stage of the game (desert, forest, mountains etc).
Generally the lower colours are regarded as background, and the upper colours as foreground, and this is used in the collision detection for the player and the landscape.
|-
| EXIT[5] || exit || 5 instances of a 6-byte structure describing the exits from the level.
|-
| WATER[5] || water1 || 5 instances of an 8-byte structure describing the regions of water in the level.
|-
| TELEPORT[5] || teleport || 5 instances of an 8-byte structure describing the regions of the game that can teleport the player.
|-
| NONSTICK[5] || nonStick || 5 instances of an 8-byte structure describing regions that the player cannot attach a rope to.
|-
| ACID[5] || acid || 5 instances of an 8-byte structure describing regions that will dissolve the player if touched.
|-
| DANGER[20] || danger || 20 instances of an 8-byte structure describing regions that will explode the player if touched.
|-
| SPRITE[10] || sprite || 10 instances of a 1688-byte structure describing sprites.
|-
| [[UINT16LE]] || blueStart || 1 if the blue form of the player is available at the start of the game.
|-
| [[UINT16LE]] || greenStart || 1 if the green form of the player is available at the start of the game.
|-
| [[UINT16LE]] || redStart || 1 if the red form of the player is available at the start of the game.
|-
| [[UINT16LE]] || yellowStart || 1 if the yellow form of the player is available at the start of the game.
|-
| [[UINT8]][12] || unknown || Purpose unknown.
|-
| FIELD[5] || redField || 5 instances of an 8-byte structure describing the particle field that enables/disables the red form of the player.
|-
| FIELD[5] || greenField || 5 instances of an 8-byte structure describing the particle field that enables/disables the green form of the player.
|-
| FIELD[5] || yellowField || 5 instances of an 8-byte structure describing the particle field that enables/disables the yellow form of the player.
|-
| FIELD[5] || blueField || 5 instances of an 8-byte structure describing the particle field that enables/disables the blue form of the player.
|-
| WATER[5] || water2 || 5 further instances of an 8-byte structure describing the regions of water in the level.

Probably one of these 2 sets of water data describes regions that start full of water and can be emptied, and the others describe regions which start empty and can be filled. I'm not sure.
|-
| [[UINT8]][10] || unknown || Purpose unknown.
|-
| [[UINT8]] || waterPaletteIndex || Index of colour in palette used for water.
|-
| [[UINT8]] || airPaletteIndex || Index of colour in palette used for air.

These two palette entries can be used to modify the image as regions of water fill/empty.
|-
| [[UINT16LE]] || time || Amount of time the player has to complete the level. In 30ths of a second (The game plays at 30 fps).
|-
| CURRENT[5] || current || 5 instances of a 10-byte structure describing regions of air or water currents.
|-
| [[UINT8]] || motePaletteIndex || Index of colour in palette used for dust motes moving in currents.
|-
| [[UINT8]] || unknown || Purpose unknown.
|-
| [[UINT16LE]] || spriteMap || Index of [[LBM Format]] <tt>SPR</tt> sprite map image to use for this level. 0 = A, 1 = B.
|-
| EXITRETURN[5] || exitReturn || 5 instances of a 4-byte structure describing where the player character should re-enter the level following a side-quest.
|-
| [[UINT16LE]][5] || exitGraphic || 5 instances of and indication of how a player is depicted exiting. 0 used for the end of the level dissolves the level viewport in a swirling vortex. 1 is smooth and is used for tunnelling in multi-map levels.
|-
| [[UINT16LE]] || unknown || Seems to indicate a row in the map at which some odd palette behaviour is observed. Possibly a bug, but it could be that the intention is to shift something in the colour scheme when the player is above ground / below ground.
|}

==== EXIT Format ====

The exit region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the exit.
|-
| [[UINT16LE]] || top || top pixel of the centre of the exit.
|-
| [[UINT16LE]] || destination || Level number less one to go to next from this exit. Also the most significant bit indicates 0 = level exit, 1 = go to side quest. 
e.g. if this value is 0x8006, then go to level 7 as a side-quest.
|}

==== WATER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the water region.
|-
| [[UINT16LE]] || top || Top pixel of the water region.
|-
| [[UINT16LE]] || right || Right pixel of the water region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the water region.
|}

==== TELEPORT Format ====

The teleport region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || srcX || Left pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || srcY || Top pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destX || Right pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destY || Bottom pixel of the centre of the teleport region.
|}

==== NONSTICK Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the non-stick region.
|-
| [[UINT16LE]] || top || Top pixel of the non-stick region.
|-
| [[UINT16LE]] || right || Right pixel of the non-stick region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the non-stick region.
|}

==== ACID Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the acid region.
|-
| [[UINT16LE]] || top || Top pixel of the acid region.
|-
| [[UINT16LE]] || right || Right pixel of the acid region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the acid region.
|}

==== DANGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the danger region.
|-
| [[UINT16LE]] || top || Top pixel of the danger region.
|-
| [[UINT16LE]] || right || Right pixel of the danger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the danger region.
|}

==== FIELD Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the particle field.
|-
| [[UINT16LE]] || top || Top pixel of the particle field.
|-
| [[UINT16LE]] || right || Right pixel of the particle field.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the particle field.
|}

==== CURRENT Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the current region.
|-
| [[UINT16LE]] || top || Top pixel of the current region.
|-
| [[UINT16LE]] || right || Right pixel of the current region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the current region.
|-
| [[UINT16LE]] || flags || bit-0 and bit-1 : direction 00 = down, 01 = right, 10 = up, 11 = left bit-2: strength of current 0 = weak, 1 = strong bit-3: show current using dust motes 0 = no, 1 = yes
|}

==== EXITRETURN Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the return region.
|-
| [[UINT16LE]] || top || Top pixel of the return region.
|}

==== REGION Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left of region
|-
| [[UINT16LE]] || top || Top of region
|-
| [[UINT16LE]] || right || Right of region
|-
| [[UINT16LE]] || bottom || Bottom of region
|}

==== SPRITE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT8]] || layer || 0 = middleground (can interact with the player) 1=background 2=foreground (player can move behind it).
|-
| [[UINT8]] || malevolence || Bit-0: sprite will kill player in ? form Bit-1: sprite will kill player in yellow form Bit-2: sprite will kill player in ? form Bit-3: sprite will kill player in ? form.
|-
| [[UINT16LE]] || unknown || Purpose unknown
|-
| [[UINT16LE]] || mask || Sprite requires a mask graphic for transparency. If a mask is required, it will be immediately below the sprite tile in the <tt>SPR</tt> file.
|-
| [[UINT16LE]] || cleanUp || The previous sprite image needs to be removed for each frame. This is not necessary if the sprite is unmasked and never changes position.
|-
| [[UINT16LE]] || strength || How much damage the sprite can sustain. 0 = infinite, otherwise 1-127.
|-
| [[UINT16LE]] || blastArea || Size of the explosion if the sprite is destroyed. (Purely a decorative concern, there is no splash damage).
|-
| [[UINT16LE]] || active || Is the sprite in use.
|-
| [[UINT8]][2] || unknown ||
|-
| REGION || furryEntryRegion || Sprite will activate if furry enters this region.
|-
| REGION || furryExitRegion || Sprite will activate if furry leaves this region.
|-
| [[UINT8]][72] || unknown || Suspect that this region is actually populated and used as working space while the level is being played.
|-
| [[UINT16LE]] || fireRate || How often the sprite fires projectiles. 0 = none, 1-5 = low-high.
|-
| [[UINT16LE]] || fireType || How are projectiles fired. 1 = All directions slowly, 2 = Right, 3 = Left, 4 = All directions medium, 5 = All directions fast.
|-
| STATE[10] || state || 10 instances of a 158-byte structure describing the states that the sprite can be in.
|}

==== STATE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite location.
|-
| [[UINT16LE]] || top || Top pixel of the sprite location.
|-
| [[UINT16LE]] || destState || Another state to move towards. The sprite will physically move to the location of the destination state, and change state when it reaches that location.
|-
| [[UINT16LE]] || speed || Speed of sprite movement 0 = None, 1-5 = slow-fast.
|-
| [[UINT8]] || movementType || 0 = horizontal then vertical, 1 = as the crow flies, 2 = just track player vertically, no sideways movement, 3 = just track player horizontally, no up/down movement, 4 = track player, 5 = fast move??, 6 = None.
|-
| [[UINT8]] || destWaterState || Another state to change to when a requested water level change is acheived.
|-
| [[UINT8]] || gravity || If 1, the sprite falls when unsupported.
|-
| [[UINT8]] || current || Control currents. Bits 0-4 specify currents affected, Bit-5 turns currents off, Bit-6 turns currents on.
|-
| [[UINT16LE]] || activateSprite || Number of another sprite to activate.
|-
| TRIGGER || entryTrigger || A 10-byte structure that describes a trigger to change state when the player enters a region.
|-
| TRIGGER || exitTrigger || A 10-byte structure that describes a trigger to change state when the player leaves a region.
|-
| TRIGGER || spriteEntryTrigger || A 10-byte structure that describes a trigger to change state when another sprite enters a region.
|-
| TRIGGER || spriteExitTrigger || A 10-byte structure that describes a trigger to change state when another sprite leaves a region (or is destroyed).
|-
| [[UINT8]] || destroy || The sprite is destroyed (deactivated) when it enters this state.
|-
| [[UINT8]] || bounce || The sprite bounces ballistically when it hits a surface.
|-
| [[UINT16LE]] || emptyWater || Bits 8-15 speed of emptying, Bits 0-7 number of water region to empty.
|-
| [[UINT16LE]] || fillWater || Bits 8-15 speed of filling, Bits 0-7 number of water region to fill.
|-
| [[UINT8]][4] || unknown || Seems to affect the starting location of projectiles, relative to the sprite location.
|-
| [[UINT16LE]] || waterTriggerLeft || Left pixel of region for water trigger (see destWaterState field).
|-
| [[UINT16LE]] || waterTriggerTop || Top pixel of region for water trigger.
|-
| [[UINT16LE]] || waterTriggerRight || Right pixel of region for water trigger.
|-
| FRAME[10] || frame || 10 instances of an 8-byte structure describing the sprite tile location within the <tt>SPR</tt> image file
|-
| [[UINT16LE]] || animSpeed || Rate of frame change of sprite animation.
|-
| [[UINT16LE]] || cycle || Does the animation cycle repeat.
|-
| [[UINT8]] || cycleCount || Number of animation frames before changing state.
|-
| [[UINT8]] || animTriggerState || Sprite state to move to when cycleCount is reached.
|-
| [[UINT16LE]] || waterTriggerBottom || Bottom pixel of region for water trigger.
|}

==== TRIGGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || state || State to move to when triggered.
|-
| [[UINT16LE]] || left || Left pixel of the trigger region.
|-
| [[UINT16LE]] || top || Top pixel of the trigger region.
|-
| [[UINT16LE]] || right || Right pixel of the trigger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the trigger region.
|}

==== FRAME Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || top || Top pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || right || Right pixel of the sprite on the <tt>SPR</tt> image file + 8 pixels.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the sprite on the <tt>SPR</tt> image file.
|}

== Notes ==

There are 10 different stages in the game, and correspondingly 10 different tile and sprite sets.

The tile images for the backgrounds and landscape are stored in the <tt>DEC</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>DECORxx.LBM</tt> where xx is specified by the decFile field of the main structure.

The sprite images are stored in the <tt>SPR</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>SPRxxn</tt> where xx is specified by the decFile field of the main structure, and n is specified by the spriteMap field in the main structure.

The sprites can be of varying sizes, the FRAME data structure describes the bounding box in pixels within the sprite image file. If the sprite requires a transparency mask, then this mask will be a rectangular region with the same size as the sprite, and placed in the image file immediately below the sprite.

Within the tile image file, all the tiles are 16 × 16 pixels, tiles are referenced in the main file structure as a pair of byte coordinates, giving the X and Y position in tiles within the image file.

Certain tiles in the image file have special meaning.

The tile at 0,1 is a coin. If the player touches this tile in the level, they will gain a coin, and the tile will be swapped out for the tile at 0,0 which is always empty.

The tile at 0,2 is an extra life. If the player touches this tile in the level, they will gain an extra life, and the tile will be swapped out for the tile at 0,0.

The tile at 0,3 is a time extension. If the player touches this tile in the level, they will gain an extra 30 seconds on the clock, and the tile will be swapped out for the tile at 0,0.

All the remaining tiles on rows 0, 1 and 2 in the map are destructible tiles. The red form of the player can chew through the scenery. Chewing a tile from row 0 will cause that tile to be swapped out with the tile immediately below it in row 1. Chewing a tile from row 1 will cause that tile to be swapped out with the tile immediately below it in row 2. Chewing a tile from row 2 will cause that tile to be swapped out with the tile at 0,0, which is empty, so the player can then get through the gap created. Typically the tiles in these rows depict a gradually degraded state, you can have tiles that require more or less action to destroy them, by choosing from the three rows. Often the top row tiles are visually indistinguishable from some other non-destructible tiles in the tileset, allowing you to hide destructible tiles.

== Tools ==

{{BeginFileFormatTools|Type=group}}
{{FileFormatTool
| Name = [[FuryUtils]]
| Platform = x64Windows, Linux
| canExtract = Yes
| canDecompress = Yes
| canCreate = Yes
| canModify = Yes
| canCompress = Yes
| editHidden = N/A
| editMetadata = Yes
| notes =
}}
{{EndFileFormatTools}}

== Credits ==

This file format was reverse engineered by [[User:Carbon14|carbon14]]. 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!)

BIN Format (Fury of the Furries)

2023-09-08T15:02:20Z

Carbon14: /* STATE Format */ correct endianess of empty / fill instructions

{{Map Infobox
| Type = 2D tile-based
| Layers = 3
| Tile size = 16×16
| Viewport = 320×200
| Games =
{{Game|Fury of the Furries}}
{{Game|Pac-In-Time}}
}}

[[Fury of the Furries]] maps contain the static background and landscape for the level, collectable coins, time extensions and extra lives and destructible bricks. They also contain the 'scripting for the game play itself', this is in the form of the definitions of the sprites that interact with the player character. There are up to 10 sprites in the level, each having up to 10 states. Triggers are defined for switching between states, and for the player and or sprites to switch on or off other game-play elements.

The file itself is run-length encoded, and after decompression is always a fixed length. Generally unused elements within the game are marked by the [[UINT16LE]] value 0xFFFF.

== File Formats ==

=== RLE Compressed File Format ===

{|class="wikitable"
! Data Type || Name || Description
|-
| FOURCC || header || Appears to be a header with version number. Most files decompress to an object 25518 bytes in length, but a handful of files are shorter, and appear to be earlier versions. 
byte is the shortest, at 25432 bytes, the last entry is the time field. 
byt1 and byt3 are 25482 bytes long, and include currents. 
byt4 is 25518, it's the version seen for the vast majority of the files, and includes all the fields after the currents.
|-
| [[UINT16LE]] || length || Number of bytes in section. 
if zero then stop decompressing. 
if less than 0x7D00 then use the following length bytes from the input. 
otherwise use the following byte from the input (length - 0x7D00) times. 
 
compressed and uncompressed sections always alternate, even if this makes the packing less efficient. This means that if you have two adjacent runs, There will be at least 1 character represented as uncompressed.
|-
| ... || etc || continue with another 'length' until the final file size is achieved (25,518 bytes), or you read a 0 length.
|}

The file should end with a zero length section. i.e. two bytes of 0.

=== Uncompressed File Format ===

==== FILE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || mapWidth || Width of the playable area (in tiles) between 20 and 78.
|-
| [[UINT16LE]] || mapHeight || Height of the playable area (in tiles) between 13 and 51.

The maximum number of tiles in a game is 1024. This places constraints on the width and height.
The minimum width is 20 to match the viewport size of 320 pixels, and this constrains the height to 51 (20 × 51 = 1020).
The minimum height is 13 to match the viewport size of 200 pixels, and this constrains the width to 78 (13 × 78 = 1014).
Any other combination of width and height is possible so long as it meets these constraints.
|-
| [[UINT8]][2][78 × 51] || tileIndex || Pairs of coordinates into a [[LBM Format]] <tt>DEC</tt> file containing the tiles.
|-
| [[UINT16LE]] || decFile || The <tt>DEC</tt> file number less one. i.e. a value of 3 indicates <tt>DECOR04.LBM</tt>.
|-
| [[UINT16LE]] || startLeft || The left of the starting position for the player character, less 8 pixels.
|-
| [[UINT16LE]] || startTop || The top of the starting position for the player character.
|-
| [[UINT16LE]] || foregroundPaletteIndex || The index of the first palette entry to be regarded as foreground.

The palette for the <tt>DEC</tt> file has 16 colours and they are used in a particular order. The first is always black and is background (i.e. the player character is not blocked by this colour)
The next 4 usually dark versions of yellow, red, green and blue and are used for the shadow colour of the player character sprite, in the 4 different forms that the player can take.
The next colour (colour 5 in the palette) is the bright colour of the player character, and will be swapped out as the player changes form.
The remaining colours a chosen to suit the needs of the stage of the game (desert, forest, mountains etc).
Generally the lower colours are regarded as background, and the upper colours as foreground, and this is used in the collision detection for the player and the landscape.
|-
| EXIT[5] || exit || 5 instances of a 6-byte structure describing the exits from the level.
|-
| WATER[5] || water1 || 5 instances of an 8-byte structure describing the regions of water in the level.
|-
| TELEPORT[5] || teleport || 5 instances of an 8-byte structure describing the regions of the game that can teleport the player.
|-
| NONSTICK[5] || nonStick || 5 instances of an 8-byte structure describing regions that the player cannot attach a rope to.
|-
| ACID[5] || acid || 5 instances of an 8-byte structure describing regions that will dissolve the player if touched.
|-
| DANGER[20] || danger || 20 instances of an 8-byte structure describing regions that will explode the player if touched.
|-
| SPRITE[10] || sprite || 10 instances of a 1688-byte structure describing sprites.
|-
| [[UINT16LE]] || blueStart || 1 if the blue form of the player is available at the start of the game.
|-
| [[UINT16LE]] || greenStart || 1 if the green form of the player is available at the start of the game.
|-
| [[UINT16LE]] || redStart || 1 if the red form of the player is available at the start of the game.
|-
| [[UINT16LE]] || yellowStart || 1 if the yellow form of the player is available at the start of the game.
|-
| [[UINT8]][12] || unknown || Purpose unknown.
|-
| FIELD[5] || redField || 5 instances of an 8-byte structure describing the particle field that enables/disables the red form of the player.
|-
| FIELD[5] || greenField || 5 instances of an 8-byte structure describing the particle field that enables/disables the green form of the player.
|-
| FIELD[5] || yellowField || 5 instances of an 8-byte structure describing the particle field that enables/disables the yellow form of the player.
|-
| FIELD[5] || blueField || 5 instances of an 8-byte structure describing the particle field that enables/disables the blue form of the player.
|-
| WATER[5] || water2 || 5 further instances of an 8-byte structure describing the regions of water in the level.

Probably one of these 2 sets of water data describes regions that start full of water and can be emptied, and the others describe regions which start empty and can be filled. I'm not sure.
|-
| [[UINT8]][10] || unknown || Purpose unknown.
|-
| [[UINT8]] || waterPaletteIndex || Index of colour in palette used for water.
|-
| [[UINT8]] || airPaletteIndex || Index of colour in palette used for air.

These two palette entries can be used to modify the image as regions of water fill/empty.
|-
| [[UINT16LE]] || time || Amount of time the player has to complete the level. In 30ths of a second (The game plays at 30 fps).
|-
| CURRENT[5] || current || 5 instances of a 10-byte structure describing regions of air or water currents.
|-
| [[UINT8]] || motePaletteIndex || Index of colour in palette used for dust motes moving in currents.
|-
| [[UINT8]] || unknown || Purpose unknown.
|-
| [[UINT16LE]] || spriteMap || Index of [[LBM Format]] <tt>SPR</tt> sprite map image to use for this level. 0 = A, 1 = B.
|-
| EXITRETURN[5] || exitReturn || 5 instances of a 4-byte structure describing where the player character should re-enter the level following a side-quest.
|-
| [[UINT16LE]][5] || exitGraphic || 5 instances of and indication of how a player is depicted exiting. 0 used for the end of the level dissolves the level viewport in a swirling vortex. 1 is smooth and is used for tunnelling in multi-map levels.
|-
| [[UINT16LE]] || unknown || Seems to indicate a row in the map at which some odd palette behaviour is observed. Possibly a bug, but it could be that the intention is to shift something in the colour scheme when the player is above ground / below ground.
|}

==== EXIT Format ====

The exit region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the exit.
|-
| [[UINT16LE]] || top || top pixel of the centre of the exit.
|-
| [[UINT16LE]] || destination || Level number less one to go to next from this exit. Also the most significant bit indicates 0 = level exit, 1 = go to side quest. 
e.g. if this value is 0x8006, then go to level 7 as a side-quest.
|}

==== WATER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the water region.
|-
| [[UINT16LE]] || top || Top pixel of the water region.
|-
| [[UINT16LE]] || right || Right pixel of the water region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the water region.
|}

==== TELEPORT Format ====

The teleport region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || srcX || Left pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || srcY || Top pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destX || Right pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destY || Bottom pixel of the centre of the teleport region.
|}

==== NONSTICK Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the non-stick region.
|-
| [[UINT16LE]] || top || Top pixel of the non-stick region.
|-
| [[UINT16LE]] || right || Right pixel of the non-stick region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the non-stick region.
|}

==== ACID Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the acid region.
|-
| [[UINT16LE]] || top || Top pixel of the acid region.
|-
| [[UINT16LE]] || right || Right pixel of the acid region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the acid region.
|}

==== DANGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the danger region.
|-
| [[UINT16LE]] || top || Top pixel of the danger region.
|-
| [[UINT16LE]] || right || Right pixel of the danger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the danger region.
|}

==== FIELD Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the particle field.
|-
| [[UINT16LE]] || top || Top pixel of the particle field.
|-
| [[UINT16LE]] || right || Right pixel of the particle field.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the particle field.
|}

==== CURRENT Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the current region.
|-
| [[UINT16LE]] || top || Top pixel of the current region.
|-
| [[UINT16LE]] || right || Right pixel of the current region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the current region.
|-
| [[UINT16LE]] || flags || bit-0 and bit-1 : direction 00 = down, 01 = right, 10 = up, 11 = left bit-2: strength of current 0 = weak, 1 = strong bit-3: show current using dust motes 0 = no, 1 = yes
|}

==== EXITRETURN Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the return region.
|-
| [[UINT16LE]] || top || Top pixel of the return region.
|}

==== REGION Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left of region
|-
| [[UINT16LE]] || top || Top of region
|-
| [[UINT16LE]] || right || Right of region
|-
| [[UINT16LE]] || bottom || Bottom of region
|}

==== SPRITE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT8]] || layer || 0 = middleground (can interact with the player) 1=background 2=foreground (player can move behind it).
|-
| [[UINT8]] || malevolence || Bit-0: sprite will kill player in ? form Bit-1: sprite will kill player in yellow form Bit-2: sprite will kill player in ? form Bit-3: sprite will kill player in ? form.
|-
| [[UINT16LE]] || unknown || Purpose unknown
|-
| [[UINT16LE]] || mask || Sprite requires a mask graphic for transparency. If a mask is required, it will be immediately below the sprite tile in the <tt>SPR</tt> file.
|-
| [[UINT16LE]] || cleanUp || The previous sprite image needs to be removed for each frame. This is not necessary if the sprite is unmasked and never changes position.
|-
| [[UINT16LE]] || strength || How much damage the sprite can sustain. 0 = infinite, otherwise 1-127.
|-
| [[UINT16LE]] || blastArea || Size of the explosion if the sprite is destroyed. (Purely a decorative concern, there is no splash damage).
|-
| [[UINT16LE]] || active || Is the sprite in use.
|-
| [[UINT8]][2] || unknown ||
|-
| REGION || furryEntryRegion || Sprite will activate if furry enters this region.
|-
| REGION || furryExitRegion || Sprite will activate if furry leaves this region.
|-
| [[UINT8]][72] || unknown || Suspect that this region is actually populated and used as working space while the level is being played.
|-
| [[UINT16LE]] || fireRate || How often the sprite fires projectiles. 0 = none, 1-5 = low-high.
|-
| [[UINT16LE]] || fireType || How are projectiles fired. 1 = All directions slowly, 2 = Right, 3 = Left, 4 = All directions medium, 5 = All directions fast.
|-
| STATE[10] || state || 10 instances of a 158-byte structure describing the states that the sprite can be in.
|}

==== STATE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite location.
|-
| [[UINT16LE]] || top || Top pixel of the sprite location.
|-
| [[UINT16LE]] || destState || Another state to move towards. The sprite will physically move to the location of the destination state, and change state when it reaches that location.
|-
| [[UINT16LE]] || speed || Speed of sprite movement 0 = None, 1-5 = slow-fast.
|-
| [[UINT8]] || movementType || 0 = horizontal then vertical, 1 = as the crow flies, 2 = just track player vertically, no sideways movement, 3 = just track player horizontally, no up/down movement, 4 = track player, 5 = fast move??, 6 = None.
|-
| [[UINT8]] || destWaterState || Another state to change to when a requested water level change is acheived.
|-
| [[UINT8]] || gravity || If 1, the sprite falls when unsupported.
|-
| [[UINT8]] || current || Control currents. Bits 0-4 specify currents affected, Bit-5 turns currents off, Bit-6 turns currents on.
|-
| [[UINT16LE]] || activateSprite || Number of another sprite to activate.
|-
| TRIGGER || entryTrigger || A 10-byte structure that describes a trigger to change state when the player enters a region.
|-
| TRIGGER || exitTrigger || A 10-byte structure that describes a trigger to change state when the player leaves a region.
|-
| TRIGGER || spriteEntryTrigger || A 10-byte structure that describes a trigger to change state when another sprite enters a region.
|-
| TRIGGER || spriteExitTrigger || A 10-byte structure that describes a trigger to change state when another sprite leaves a region (or is destroyed).
|-
| [[UINT8]] || destroy || The sprite is destroyed (deactivated) when it enters this state.
|-
| [[UINT8]] || bounce || The sprite bounces ballistically when it hits a surface.
|-
| [[UINT16LE]] || emptyWater || Bits 8-15 speed of emptying, Bits 0-7 number of water region to empty.
|-
| [[UINT16LE]] || fillWater || Bits 8-15 speed of filling, Bits 0-7 number of water region to fill.
|-
| [[UINT8]][4] || unknown || Seems to affect the starting location of projectiles, relative to the sprite location.
|-
| [[UINT16LE]] || waterTriggerLeft || Left pixel of region for water trigger (see destWaterState field).
|-
| [[UINT16LE]] || waterTriggerTop || Top pixel of region for water trigger.
|-
| [[UINT16LE]] || waterTriggerRight || Right pixel of region for water trigger.
|-
| FRAME[10] || frame || 10 instances of an 8-byte structure describing the sprite tile location within the <tt>SPR</tt> image file
|-
| [[UINT16LE]] || animSpeed || Rate of frame change of sprite animation.
|-
| [[UINT16LE]] || cycle || Does the animation cycle repeat.
|-
| [[UINT8]] || cycleCount || Number of animation frames before changing state.
|-
| [[UINT8]] || animTriggerState || Sprite state to move to when cycleCount is reached.
|-
| [[UINT16LE]] || waterTriggerBottom || Bottom pixel of region for water trigger.
|}

==== TRIGGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || state || State to move to when triggered.
|-
| [[UINT16LE]] || left || Left pixel of the trigger region.
|-
| [[UINT16LE]] || top || Top pixel of the trigger region.
|-
| [[UINT16LE]] || right || Right pixel of the trigger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the trigger region.
|}

==== FRAME Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || top || Top pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || right || Right pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the sprite on the <tt>SPR</tt> image file.
|}

== Notes ==

There are 10 different stages in the game, and correspondingly 10 different tile and sprite sets.

The tile images for the backgrounds and landscape are stored in the <tt>DEC</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>DECORxx.LBM</tt> where xx is specified by the decFile field of the main structure.

The sprite images are stored in the <tt>SPR</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>SPRxxn</tt> where xx is specified by the decFile field of the main structure, and n is specified by the spriteMap field in the main structure.

The sprites can be of varying sizes, the FRAME data structure describes the bounding box in pixels within the sprite image file. If the sprite requires a transparency mask, then this mask will be a rectangular region with the same size as the sprite, and placed in the image file immediately below the sprite.

Within the tile image file, all the tiles are 16 × 16 pixels, tiles are referenced in the main file structure as a pair of byte coordinates, giving the X and Y position in tiles within the image file.

Certain tiles in the image file have special meaning.

The tile at 0,1 is a coin. If the player touches this tile in the level, they will gain a coin, and the tile will be swapped out for the tile at 0,0 which is always empty.

The tile at 0,2 is an extra life. If the player touches this tile in the level, they will gain an extra life, and the tile will be swapped out for the tile at 0,0.

The tile at 0,3 is a time extension. If the player touches this tile in the level, they will gain an extra 30 seconds on the clock, and the tile will be swapped out for the tile at 0,0.

All the remaining tiles on rows 0, 1 and 2 in the map are destructible tiles. The red form of the player can chew through the scenery. Chewing a tile from row 0 will cause that tile to be swapped out with the tile immediately below it in row 1. Chewing a tile from row 1 will cause that tile to be swapped out with the tile immediately below it in row 2. Chewing a tile from row 2 will cause that tile to be swapped out with the tile at 0,0, which is empty, so the player can then get through the gap created. Typically the tiles in these rows depict a gradually degraded state, you can have tiles that require more or less action to destroy them, by choosing from the three rows. Often the top row tiles are visually indistinguishable from some other non-destructible tiles in the tileset, allowing you to hide destructible tiles.

== Tools ==

{{BeginFileFormatTools|Type=group}}
{{FileFormatTool
| Name = [[FuryUtils]]
| Platform = x64Windows, Linux
| canExtract = Yes
| canDecompress = Yes
| canCreate = Yes
| canModify = Yes
| canCompress = Yes
| editHidden = N/A
| editMetadata = Yes
| notes =
}}
{{EndFileFormatTools}}

== Credits ==

This file format was reverse engineered by [[User:Carbon14|carbon14]]. 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!)

Fury of the Furries

2023-09-01T15:56:28Z

Carbon14: Add external link to reference documentation

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

[[Fury of the Furries]] (also subsequently reskinned as '''Pac-In-Time''') is a puzzle-platform game for the PC, Macintosh, Amiga and Amiga-32, developed by [https://en.wikipedia.org/wiki/Kalisto_Entertainment Kalisto] and released by [https://en.wikipedia.org/wiki/Mindscape_(company) Mindscape] in 1993

== Obtaining the game ==

The game has not been officially released as freeware.

{{BeginGameFileList}}
{{GameFile
| Name = *.dat
| Format = [[DAT Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Archive collection of other files, used by either of the preliminary executables (intro.dat or lang.dat)
}}
{{GameFile
| Name = messages.*
| Format = [[MESSAGES Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Text strings in different languages
}}
{{GameFile
| Name = passw.dta
| Format = [[DTA Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Passwords used in the games cheat protection
}}
{{GameFile
| Name = prot.*
| Format = [[PROT Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Text strings in different languages for the cheat protection screen
}}
{{GameFile
| Name = lang.txt
| Format = [[LANG.TXT Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Selection of languages supported by the game
}}
{{GameFile
| Name = furies.anm
| Format = [[ANM Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Arrangement of icons on the screen during language selection
}}
{{GameFile
| Name = *.kmd
| Format = [[KMD Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Obscure MOD file music format
}}
{{GameFile
| Name = *.iff
| Format = [[AIFF Format]]
| KnownFormat = Yes
| Desc = Sound effect in AIFF format
}}
{{GameFile
| Name = spr/*.lbm
| Format = [[LBM Format]]
| KnownFormat = Yes
| Desc = 4-bit Image file contains player and enemy sprites
}}
{{GameFile
| Name = dec/*.lbm
| Format = [[LBM Format]]
| KnownFormat = Yes
| Desc = 4-bit Image file containing backgrounds for game levels
}}
{{GameFile
| Name = pic/*.lbm
| Format = [[LBM Format]]
| KnownFormat = Yes
| Desc = 16-bit Image file containing cut scene images
}}
{{GameFile
| Name = dat/data*.bin
| Format = [[BIN Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Game level data
}}
{{GameFile
| Name = dat/cdata*.bin
| Format = CDATA Format (Fury of the Furries)
| KnownFormat = No
| Desc = Unknown
}}
{{GameFile
| Name = dat/demo*.bin
| Format = [[DEMO Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Script for automatic playing of certain game levels in 'attract mode'
}}
{{GameFile
| Name = dat/fdata*.bin
| Format = FDATA Format (Fury of the Furries)
| KnownFormat = No
| Desc = Unknown
}}
{{GameFile
| Name = dat/gamedat.bin
| Format = [[GAMEDAT Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = User preference settings and save progress
}}
{{GameFile
| Name = dat/sdata*.bin
| Format = SDATA Format (Fury of the Furries)
| KnownFormat = No
| Desc = Unknown
}}
{{GameFile
| Name = *.blk
| Format = [[BLK Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Pixel ranges used to select sections of images
}}
{{GameFile
| Name = *.imm
| Format = [[IMM Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Pixel information for an image, but without a color palette
}}
{{GameFile
| Name = *.lmh
| Format = [[LMH LMO Format (Fury of the Furries)|LMH Format]]
| KnownFormat = Yes
| Desc = Part of an animation for the game intro
}}
{{GameFile
| Name = *.lmo
| Format = [[LMH LMO Format (Fury of the Furries)|LMO Format]]
| KnownFormat = Yes
| Desc = Part of an animation for the game intro
}}
{{GameFile
| Name = *.pam
| Format = [[VGA Palette]] (modern form)
| KnownFormat = Yes
| Desc = Palette information for images
}}
{{GameFile
| Name = *.snd
| Format = [[SND Format (Fury of the Furries)]]
| KnownFormat = Yes
| Desc = Sound effects used in the game intro
}}
{{EndGameFileList}}

== Links ==

* [https://github.com/david-c14/FuryStudio/blob/v0.4.1-dev/doc/reference/index.md A developing hypertext reference for the behaviour of the game engine]

== Notes ==

[[Category:Mindscape]]
[[Category:Puzzle-Platformer]]

User:Carbon14

2023-08-22T07:06:42Z

Carbon14: Added link to experiments playlist

UK based computer programmer since 1982.

Currently researching the 1993 game 'Fury of the Furries' published by Kalisto.

Also black-box testing Yamaha OPL synthesizers with a view to a clock-by-clock perfect description of the chip behaviour (as featured in Ad-lib compatible sound cards)

likes: DOS, Assembler, nachos

hates: Windows 8.1, Visual Basic, shellfish

Updated 2023: Still researching 'Fury of the Furries' currently working on a level editor

July 2023: I think I've reached a milestone. With the release of version 0.4.0 of the toolset, it's now practical to actually mod the game, producing new levels. My next target is a series of experiments to prove and refine the fine detail of the game data, possible even to fill in some of the remaining holes in the knowledge.

[https://www.youtube.com/playlist?list=PLjTRBUwQYI14I0n8tNQtZICVa9EvJeti3 Experiments]

User:Carbon14

2023-07-26T18:27:46Z

Carbon14: Typo.

User:Carbon14

2023-07-26T13:17:01Z

Carbon14: Update state of play

UK based computer programmer since 1982.

Currently researching the 1984 game 'Fury of the Furries' published by Kalisto.

Also black-box testing Yamaha OPL synthesizers with a view to a clock-by-clock perfect description of the chip behaviour (as featured in Ad-lib compatible sound cards)

likes: DOS, Assembler, nachos

hates: Windows 8.1, Visual Basic, shellfish

Updated 2023: Still researching 'Fury of the Furries' currently working on a level editor

July 2023: I think I've reached a milestone. With the release of version 0.4.0 of the toolset, it's now practical to actually mod the game, producing new levels. My next target is a series of experiments to prove and refine the fine detail of the game data, possible even to fill in some of the remaining holes in the knowledge.

FuryUtils

2023-07-26T13:14:28Z

Carbon14: Include details of new addition to the tool set. - BinFile utility.

{{Tool Infobox
| Platform = Windows, Linux
| Release = 2023-04-28 
| Download = [https://github.com/david-c14/FuryStudio/releases/ Releases]
| Edit1 = Extraction
| Edit2 = Format Conversion
| Games =
{{Game|Fury of the Furries}}
}}

'''FuryUtils''' is a suite of tools for modding [[Fury of the Furries]]

* '''BinFile''' is a command line tool for converting game level data [[BIN Format (Fury of the Furries)|(DAT/DATA*.BIN)]] files to and from a yaml text description.

* '''DatFile''' is a command line tool for packing and unpacking [[DAT Format (Fury of the Furries)|DAT Format]] archive files.

* '''ImmFile''' is a command line tool for converting [[LBM Format]] and [[IMM Format (Fury of the Furries)|IMM Format]] images files to and from Windows BMP format files.

* There is also a library suitable for C, C++ or C#, containing the same functionality, if you want to build these formats into your own tools.

== Documentation ==

The Utils zip or tar-gz package contains a suite of command line utilities and documentation in markdown format (readable as text). (Windows and Linux)

The Lib zip or tar-gz package contains the core libraries with APIs for C or C++ and a .NET assembly wrapper, along with documentation and code samples. (Windows and Linux)

== Status ==

The suite is currently under active development, and more tools are anticipated.

BIN Format (Fury of the Furries)

2023-07-26T13:11:14Z

Carbon14: Add tools section, following updated release of tool

{{Map Infobox
| Type = 2D tile-based
| Layers = 3
| Tile size = 16×16
| Viewport = 320×200
| Games =
{{Game|Fury of the Furries}}
{{Game|Pac-In-Time}}
}}

[[Fury of the Furries]] maps contain the static background and landscape for the level, collectable coins, time extensions and extra lives and destructible bricks. They also contain the 'scripting for the game play itself', this is in the form of the definitions of the sprites that interact with the player character. There are up to 10 sprites in the level, each having up to 10 states. Triggers are defined for switching between states, and for the player and or sprites to switch on or off other game-play elements.

The file itself is run-length encoded, and after decompression is always a fixed length. Generally unused elements within the game are marked by the [[UINT16LE]] value 0xFFFF.

== File Formats ==

=== RLE Compressed File Format ===

{|class="wikitable"
! Data Type || Name || Description
|-
| FOURCC || header || Appears to be a header with version number. Most files decompress to an object 25518 bytes in length, but a handful of files are shorter, and appear to be earlier versions. 
byte is the shortest, at 25432 bytes, the last entry is the time field. 
byt1 and byt3 are 25482 bytes long, and include currents. 
byt4 is 25518, it's the version seen for the vast majority of the files, and includes all the fields after the currents.
|-
| [[UINT16LE]] || length || Number of bytes in section. 
if zero then stop decompressing. 
if less than 0x7D00 then use the following length bytes from the input. 
otherwise use the following byte from the input (length - 0x7D00) times. 
 
compressed and uncompressed sections always alternate, even if this makes the packing less efficient. This means that if you have two adjacent runs, There will be at least 1 character represented as uncompressed.
|-
| ... || etc || continue with another 'length' until the final file size is achieved (25,518 bytes), or you read a 0 length.
|}

The file should end with a zero length section. i.e. two bytes of 0.

=== Uncompressed File Format ===

==== FILE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || mapWidth || Width of the playable area (in tiles) between 20 and 78.
|-
| [[UINT16LE]] || mapHeight || Height of the playable area (in tiles) between 13 and 51.

The maximum number of tiles in a game is 1024. This places constraints on the width and height.
The minimum width is 20 to match the viewport size of 320 pixels, and this constrains the height to 51 (20 × 51 = 1020).
The minimum height is 13 to match the viewport size of 200 pixels, and this constrains the width to 78 (13 × 78 = 1014).
Any other combination of width and height is possible so long as it meets these constraints.
|-
| [[UINT8]][2][78 × 51] || tileIndex || Pairs of coordinates into a [[LBM Format]] <tt>DEC</tt> file containing the tiles.
|-
| [[UINT16LE]] || decFile || The <tt>DEC</tt> file number less one. i.e. a value of 3 indicates <tt>DECOR04.LBM</tt>.
|-
| [[UINT16LE]] || startLeft || The left of the starting position for the player character, less 8 pixels.
|-
| [[UINT16LE]] || startTop || The top of the starting position for the player character.
|-
| [[UINT16LE]] || foregroundPaletteIndex || The index of the first palette entry to be regarded as foreground.

The palette for the <tt>DEC</tt> file has 16 colours and they are used in a particular order. The first is always black and is background (i.e. the player character is not blocked by this colour)
The next 4 usually dark versions of yellow, red, green and blue and are used for the shadow colour of the player character sprite, in the 4 different forms that the player can take.
The next colour (colour 5 in the palette) is the bright colour of the player character, and will be swapped out as the player changes form.
The remaining colours a chosen to suit the needs of the stage of the game (desert, forest, mountains etc).
Generally the lower colours are regarded as background, and the upper colours as foreground, and this is used in the collision detection for the player and the landscape.
|-
| EXIT[5] || exit || 5 instances of a 6-byte structure describing the exits from the level.
|-
| WATER[5] || water1 || 5 instances of an 8-byte structure describing the regions of water in the level.
|-
| TELEPORT[5] || teleport || 5 instances of an 8-byte structure describing the regions of the game that can teleport the player.
|-
| NONSTICK[5] || nonStick || 5 instances of an 8-byte structure describing regions that the player cannot attach a rope to.
|-
| ACID[5] || acid || 5 instances of an 8-byte structure describing regions that will dissolve the player if touched.
|-
| DANGER[20] || danger || 20 instances of an 8-byte structure describing regions that will explode the player if touched.
|-
| SPRITE[10] || sprite || 10 instances of a 1688-byte structure describing sprites.
|-
| [[UINT16LE]] || blueStart || 1 if the blue form of the player is available at the start of the game.
|-
| [[UINT16LE]] || greenStart || 1 if the green form of the player is available at the start of the game.
|-
| [[UINT16LE]] || redStart || 1 if the red form of the player is available at the start of the game.
|-
| [[UINT16LE]] || yellowStart || 1 if the yellow form of the player is available at the start of the game.
|-
| [[UINT8]][12] || unknown || Purpose unknown.
|-
| FIELD[5] || redField || 5 instances of an 8-byte structure describing the particle field that enables/disables the red form of the player.
|-
| FIELD[5] || greenField || 5 instances of an 8-byte structure describing the particle field that enables/disables the green form of the player.
|-
| FIELD[5] || yellowField || 5 instances of an 8-byte structure describing the particle field that enables/disables the yellow form of the player.
|-
| FIELD[5] || blueField || 5 instances of an 8-byte structure describing the particle field that enables/disables the blue form of the player.
|-
| WATER[5] || water2 || 5 further instances of an 8-byte structure describing the regions of water in the level.

Probably one of these 2 sets of water data describes regions that start full of water and can be emptied, and the others describe regions which start empty and can be filled. I'm not sure.
|-
| [[UINT8]][10] || unknown || Purpose unknown.
|-
| [[UINT8]] || waterPaletteIndex || Index of colour in palette used for water.
|-
| [[UINT8]] || airPaletteIndex || Index of colour in palette used for air.

These two palette entries can be used to modify the image as regions of water fill/empty.
|-
| [[UINT16LE]] || time || Amount of time the player has to complete the level. In 30ths of a second (The game plays at 30 fps).
|-
| CURRENT[5] || current || 5 instances of a 10-byte structure describing regions of air or water currents.
|-
| [[UINT8]] || motePaletteIndex || Index of colour in palette used for dust motes moving in currents.
|-
| [[UINT8]] || unknown || Purpose unknown.
|-
| [[UINT16LE]] || spriteMap || Index of [[LBM Format]] <tt>SPR</tt> sprite map image to use for this level. 0 = A, 1 = B.
|-
| EXITRETURN[5] || exitReturn || 5 instances of a 4-byte structure describing where the player character should re-enter the level following a side-quest.
|-
| [[UINT16LE]][5] || exitGraphic || 5 instances of and indication of how a player is depicted exiting. 0 used for the end of the level dissolves the level viewport in a swirling vortex. 1 is smooth and is used for tunnelling in multi-map levels.
|-
| [[UINT16LE]] || unknown || Seems to indicate a row in the map at which some odd palette behaviour is observed. Possibly a bug, but it could be that the intention is to shift something in the colour scheme when the player is above ground / below ground.
|}

==== EXIT Format ====

The exit region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the exit.
|-
| [[UINT16LE]] || top || top pixel of the centre of the exit.
|-
| [[UINT16LE]] || destination || Level number less one to go to next from this exit. Also the most significant bit indicates 0 = level exit, 1 = go to side quest. 
e.g. if this value is 0x8006, then go to level 7 as a side-quest.
|}

==== WATER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the water region.
|-
| [[UINT16LE]] || top || Top pixel of the water region.
|-
| [[UINT16LE]] || right || Right pixel of the water region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the water region.
|}

==== TELEPORT Format ====

The teleport region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || srcX || Left pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || srcY || Top pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destX || Right pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destY || Bottom pixel of the centre of the teleport region.
|}

==== NONSTICK Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the non-stick region.
|-
| [[UINT16LE]] || top || Top pixel of the non-stick region.
|-
| [[UINT16LE]] || right || Right pixel of the non-stick region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the non-stick region.
|}

==== ACID Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the acid region.
|-
| [[UINT16LE]] || top || Top pixel of the acid region.
|-
| [[UINT16LE]] || right || Right pixel of the acid region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the acid region.
|}

==== DANGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the danger region.
|-
| [[UINT16LE]] || top || Top pixel of the danger region.
|-
| [[UINT16LE]] || right || Right pixel of the danger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the danger region.
|}

==== FIELD Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the particle field.
|-
| [[UINT16LE]] || top || Top pixel of the particle field.
|-
| [[UINT16LE]] || right || Right pixel of the particle field.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the particle field.
|}

==== CURRENT Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the current region.
|-
| [[UINT16LE]] || top || Top pixel of the current region.
|-
| [[UINT16LE]] || right || Right pixel of the current region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the current region.
|-
| [[UINT16LE]] || flags || bit-0 and bit-1 : direction 00 = down, 01 = right, 10 = up, 11 = left bit-2: strength of current 0 = weak, 1 = strong bit-3: show current using dust motes 0 = no, 1 = yes
|}

==== EXITRETURN Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the return region.
|-
| [[UINT16LE]] || top || Top pixel of the return region.
|}

==== REGION Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left of region
|-
| [[UINT16LE]] || top || Top of region
|-
| [[UINT16LE]] || right || Right of region
|-
| [[UINT16LE]] || bottom || Bottom of region
|}

==== SPRITE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT8]] || layer || 0 = middleground (can interact with the player) 1=background 2=foreground (player can move behind it).
|-
| [[UINT8]] || malevolence || Bit-0: sprite will kill player in ? form Bit-1: sprite will kill player in yellow form Bit-2: sprite will kill player in ? form Bit-3: sprite will kill player in ? form.
|-
| [[UINT16LE]] || unknown || Purpose unknown
|-
| [[UINT16LE]] || mask || Sprite requires a mask graphic for transparency. If a mask is required, it will be immediately below the sprite tile in the <tt>SPR</tt> file.
|-
| [[UINT16LE]] || cleanUp || The previous sprite image needs to be removed for each frame. This is not necessary if the sprite is unmasked and never changes position.
|-
| [[UINT16LE]] || strength || How much damage the sprite can sustain. 0 = infinite, otherwise 1-127.
|-
| [[UINT16LE]] || blastArea || Size of the explosion if the sprite is destroyed. (Purely a decorative concern, there is no splash damage).
|-
| [[UINT16LE]] || active || Is the sprite in use.
|-
| [[UINT8]][2] || unknown ||
|-
| REGION || furryEntryRegion || Sprite will activate if furry enters this region.
|-
| REGION || furryExitRegion || Sprite will activate if furry leaves this region.
|-
| [[UINT8]][72] || unknown || Suspect that this region is actually populated and used as working space while the level is being played.
|-
| [[UINT16LE]] || fireRate || How often the sprite fires projectiles. 0 = none, 1-5 = low-high.
|-
| [[UINT16LE]] || fireType || How are projectiles fired. 1 = All directions slowly, 2 = Right, 3 = Left, 4 = All directions medium, 5 = All directions fast.
|-
| STATE[10] || state || 10 instances of a 158-byte structure describing the states that the sprite can be in.
|}

==== STATE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite location.
|-
| [[UINT16LE]] || top || Top pixel of the sprite location.
|-
| [[UINT16LE]] || destState || Another state to move towards. The sprite will physically move to the location of the destination state, and change state when it reaches that location.
|-
| [[UINT16LE]] || speed || Speed of sprite movement 0 = None, 1-5 = slow-fast.
|-
| [[UINT8]] || movementType || 0 = horizontal then vertical, 1 = as the crow flies, 2 = just track player vertically, no sideways movement, 3 = just track player horizontally, no up/down movement, 4 = track player, 5 = fast move??, 6 = None.
|-
| [[UINT8]] || destWaterState || Another state to change to when a requested water level change is acheived.
|-
| [[UINT8]] || gravity || If 1, the sprite falls when unsupported.
|-
| [[UINT8]] || current || Control currents. Bits 0-4 specify currents affected, Bit-5 turns currents off, Bit-6 turns currents on.
|-
| [[UINT16LE]] || activateSprite || Number of another sprite to activate.
|-
| TRIGGER || entryTrigger || A 10-byte structure that describes a trigger to change state when the player enters a region.
|-
| TRIGGER || exitTrigger || A 10-byte structure that describes a trigger to change state when the player leaves a region.
|-
| TRIGGER || spriteEntryTrigger || A 10-byte structure that describes a trigger to change state when another sprite enters a region.
|-
| TRIGGER || spriteExitTrigger || A 10-byte structure that describes a trigger to change state when another sprite leaves a region (or is destroyed).
|-
| [[UINT8]] || destroy || The sprite is destroyed (deactivated) when it enters this state.
|-
| [[UINT8]] || bounce || The sprite bounces ballistically when it hits a surface.
|-
| [[UINT16LE]] || emptyWater || Bits 0-7 speed of emptying, Bits 8-15 number of water region to empty.
|-
| [[UINT16LE]] || fillWater || Bits 0-7 speed of filling, Bits 8-15 number of water region to fill.
|-
| [[UINT8]][4] || unknown || Seems to affect the starting location of projectiles, relative to the sprite location.
|-
| [[UINT16LE]] || waterTriggerLeft || Left pixel of region for water trigger (see destWaterState field).
|-
| [[UINT16LE]] || waterTriggerTop || Top pixel of region for water trigger.
|-
| [[UINT16LE]] || waterTriggerRight || Right pixel of region for water trigger.
|-
| FRAME[10] || frame || 10 instances of an 8-byte structure describing the sprite tile location within the <tt>SPR</tt> image file
|-
| [[UINT16LE]] || animSpeed || Rate of frame change of sprite animation.
|-
| [[UINT16LE]] || cycle || Does the animation cycle repeat.
|-
| [[UINT8]] || cycleCount || Number of animation frames before changing state.
|-
| [[UINT8]] || animTriggerState || Sprite state to move to when cycleCount is reached.
|-
| [[UINT16LE]] || waterTriggerBottom || Bottom pixel of region for water trigger.
|}

==== TRIGGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || state || State to move to when triggered.
|-
| [[UINT16LE]] || left || Left pixel of the trigger region.
|-
| [[UINT16LE]] || top || Top pixel of the trigger region.
|-
| [[UINT16LE]] || right || Right pixel of the trigger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the trigger region.
|}

==== FRAME Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || top || Top pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || right || Right pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the sprite on the <tt>SPR</tt> image file.
|}

== Notes ==

There are 10 different stages in the game, and correspondingly 10 different tile and sprite sets.

The tile images for the backgrounds and landscape are stored in the <tt>DEC</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>DECORxx.LBM</tt> where xx is specified by the decFile field of the main structure.

The sprite images are stored in the <tt>SPR</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>SPRxxn</tt> where xx is specified by the decFile field of the main structure, and n is specified by the spriteMap field in the main structure.

The sprites can be of varying sizes, the FRAME data structure describes the bounding box in pixels within the sprite image file. If the sprite requires a transparency mask, then this mask will be a rectangular region with the same size as the sprite, and placed in the image file immediately below the sprite.

Within the tile image file, all the tiles are 16 × 16 pixels, tiles are referenced in the main file structure as a pair of byte coordinates, giving the X and Y position in tiles within the image file.

Certain tiles in the image file have special meaning.

The tile at 0,1 is a coin. If the player touches this tile in the level, they will gain a coin, and the tile will be swapped out for the tile at 0,0 which is always empty.

The tile at 0,2 is an extra life. If the player touches this tile in the level, they will gain an extra life, and the tile will be swapped out for the tile at 0,0.

The tile at 0,3 is a time extension. If the player touches this tile in the level, they will gain an extra 30 seconds on the clock, and the tile will be swapped out for the tile at 0,0.

All the remaining tiles on rows 0, 1 and 2 in the map are destructible tiles. The red form of the player can chew through the scenery. Chewing a tile from row 0 will cause that tile to be swapped out with the tile immediately below it in row 1. Chewing a tile from row 1 will cause that tile to be swapped out with the tile immediately below it in row 2. Chewing a tile from row 2 will cause that tile to be swapped out with the tile at 0,0, which is empty, so the player can then get through the gap created. Typically the tiles in these rows depict a gradually degraded state, you can have tiles that require more or less action to destroy them, by choosing from the three rows. Often the top row tiles are visually indistinguishable from some other non-destructible tiles in the tileset, allowing you to hide destructible tiles.

== Tools ==

{{BeginFileFormatTools|Type=group}}
{{FileFormatTool
| Name = [[FuryUtils]]
| Platform = x64Windows, Linux
| canExtract = Yes
| canDecompress = Yes
| canCreate = Yes
| canModify = Yes
| canCompress = Yes
| editHidden = N/A
| editMetadata = Yes
| notes =
}}
{{EndFileFormatTools}}

== Credits ==

This file format was reverse engineered by [[User:Carbon14|carbon14]]. 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!)

File:Mod-Fury of the Furries.png

2023-07-19T14:53:15Z

Carbon14: /* Summary */ Clarified that the graphics are not ALL new

== Summary ==
A modified level of the game with partially modified graphics

File:Mod-Fury of the Furries.png

2023-07-19T12:49:33Z

Carbon14: A modified level of the game with modified graphics

== Summary ==
A modified level of the game with modified graphics

BIN Format (Fury of the Furries)

2023-07-14T13:20:47Z

Carbon14: /* SPRITE Format */ Added detail of some previously unclear data

{{Map Infobox
| Type = 2D tile-based
| Layers = 3
| Tile size = 16×16
| Viewport = 320×200
| Games =
{{Game|Fury of the Furries}}
{{Game|Pac-In-Time}}
}}

[[Fury of the Furries]] maps contain the static background and landscape for the level, collectable coins, time extensions and extra lives and destructible bricks. They also contain the 'scripting for the game play itself', this is in the form of the definitions of the sprites that interact with the player character. There are up to 10 sprites in the level, each having up to 10 states. Triggers are defined for switching between states, and for the player and or sprites to switch on or off other game-play elements.

The file itself is run-length encoded, and after decompression is always a fixed length. Generally unused elements within the game are marked by the [[UINT16LE]] value 0xFFFF.

== File Formats ==

=== RLE Compressed File Format ===

{|class="wikitable"
! Data Type || Name || Description
|-
| FOURCC || header || Appears to be a header with version number. Most files decompress to an object 25518 bytes in length, but a handful of files are shorter, and appear to be earlier versions. 
byte is the shortest, at 25432 bytes, the last entry is the time field. 
byt1 and byt3 are 25482 bytes long, and include currents. 
byt4 is 25518, it's the version seen for the vast majority of the files, and includes all the fields after the currents.
|-
| [[UINT16LE]] || length || Number of bytes in section. 
if zero then stop decompressing. 
if less than 0x7D00 then use the following length bytes from the input. 
otherwise use the following byte from the input (length - 0x7D00) times. 
 
compressed and uncompressed sections always alternate, even if this makes the packing less efficient. This means that if you have two adjacent runs, There will be at least 1 character represented as uncompressed.
|-
| ... || etc || continue with another 'length' until the final file size is achieved (25,518 bytes), or you read a 0 length.
|}

The file should end with a zero length section. i.e. two bytes of 0.

=== Uncompressed File Format ===

==== FILE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || mapWidth || Width of the playable area (in tiles) between 20 and 78.
|-
| [[UINT16LE]] || mapHeight || Height of the playable area (in tiles) between 13 and 51.

The maximum number of tiles in a game is 1024. This places constraints on the width and height.
The minimum width is 20 to match the viewport size of 320 pixels, and this constrains the height to 51 (20 × 51 = 1020).
The minimum height is 13 to match the viewport size of 200 pixels, and this constrains the width to 78 (13 × 78 = 1014).
Any other combination of width and height is possible so long as it meets these constraints.
|-
| [[UINT8]][2][78 × 51] || tileIndex || Pairs of coordinates into a [[LBM Format]] <tt>DEC</tt> file containing the tiles.
|-
| [[UINT16LE]] || decFile || The <tt>DEC</tt> file number less one. i.e. a value of 3 indicates <tt>DECOR04.LBM</tt>.
|-
| [[UINT16LE]] || startLeft || The left of the starting position for the player character, less 8 pixels.
|-
| [[UINT16LE]] || startTop || The top of the starting position for the player character.
|-
| [[UINT16LE]] || foregroundPaletteIndex || The index of the first palette entry to be regarded as foreground.

The palette for the <tt>DEC</tt> file has 16 colours and they are used in a particular order. The first is always black and is background (i.e. the player character is not blocked by this colour)
The next 4 usually dark versions of yellow, red, green and blue and are used for the shadow colour of the player character sprite, in the 4 different forms that the player can take.
The next colour (colour 5 in the palette) is the bright colour of the player character, and will be swapped out as the player changes form.
The remaining colours a chosen to suit the needs of the stage of the game (desert, forest, mountains etc).
Generally the lower colours are regarded as background, and the upper colours as foreground, and this is used in the collision detection for the player and the landscape.
|-
| EXIT[5] || exit || 5 instances of a 6-byte structure describing the exits from the level.
|-
| WATER[5] || water1 || 5 instances of an 8-byte structure describing the regions of water in the level.
|-
| TELEPORT[5] || teleport || 5 instances of an 8-byte structure describing the regions of the game that can teleport the player.
|-
| NONSTICK[5] || nonStick || 5 instances of an 8-byte structure describing regions that the player cannot attach a rope to.
|-
| ACID[5] || acid || 5 instances of an 8-byte structure describing regions that will dissolve the player if touched.
|-
| DANGER[20] || danger || 20 instances of an 8-byte structure describing regions that will explode the player if touched.
|-
| SPRITE[10] || sprite || 10 instances of a 1688-byte structure describing sprites.
|-
| [[UINT16LE]] || blueStart || 1 if the blue form of the player is available at the start of the game.
|-
| [[UINT16LE]] || greenStart || 1 if the green form of the player is available at the start of the game.
|-
| [[UINT16LE]] || redStart || 1 if the red form of the player is available at the start of the game.
|-
| [[UINT16LE]] || yellowStart || 1 if the yellow form of the player is available at the start of the game.
|-
| [[UINT8]][12] || unknown || Purpose unknown.
|-
| FIELD[5] || redField || 5 instances of an 8-byte structure describing the particle field that enables/disables the red form of the player.
|-
| FIELD[5] || greenField || 5 instances of an 8-byte structure describing the particle field that enables/disables the green form of the player.
|-
| FIELD[5] || yellowField || 5 instances of an 8-byte structure describing the particle field that enables/disables the yellow form of the player.
|-
| FIELD[5] || blueField || 5 instances of an 8-byte structure describing the particle field that enables/disables the blue form of the player.
|-
| WATER[5] || water2 || 5 further instances of an 8-byte structure describing the regions of water in the level.

Probably one of these 2 sets of water data describes regions that start full of water and can be emptied, and the others describe regions which start empty and can be filled. I'm not sure.
|-
| [[UINT8]][10] || unknown || Purpose unknown.
|-
| [[UINT8]] || waterPaletteIndex || Index of colour in palette used for water.
|-
| [[UINT8]] || airPaletteIndex || Index of colour in palette used for air.

These two palette entries can be used to modify the image as regions of water fill/empty.
|-
| [[UINT16LE]] || time || Amount of time the player has to complete the level. In 30ths of a second (The game plays at 30 fps).
|-
| CURRENT[5] || current || 5 instances of a 10-byte structure describing regions of air or water currents.
|-
| [[UINT8]] || motePaletteIndex || Index of colour in palette used for dust motes moving in currents.
|-
| [[UINT8]] || unknown || Purpose unknown.
|-
| [[UINT16LE]] || spriteMap || Index of [[LBM Format]] <tt>SPR</tt> sprite map image to use for this level. 0 = A, 1 = B.
|-
| EXITRETURN[5] || exitReturn || 5 instances of a 4-byte structure describing where the player character should re-enter the level following a side-quest.
|-
| [[UINT16LE]][5] || exitGraphic || 5 instances of and indication of how a player is depicted exiting. 0 used for the end of the level dissolves the level viewport in a swirling vortex. 1 is smooth and is used for tunnelling in multi-map levels.
|-
| [[UINT16LE]] || unknown || Seems to indicate a row in the map at which some odd palette behaviour is observed. Possibly a bug, but it could be that the intention is to shift something in the colour scheme when the player is above ground / below ground.
|}

==== EXIT Format ====

The exit region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the exit.
|-
| [[UINT16LE]] || top || top pixel of the centre of the exit.
|-
| [[UINT16LE]] || destination || Level number less one to go to next from this exit. Also the most significant bit indicates 0 = level exit, 1 = go to side quest. 
e.g. if this value is 0x8006, then go to level 7 as a side-quest.
|}

==== WATER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the water region.
|-
| [[UINT16LE]] || top || Top pixel of the water region.
|-
| [[UINT16LE]] || right || Right pixel of the water region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the water region.
|}

==== TELEPORT Format ====

The teleport region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || srcX || Left pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || srcY || Top pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destX || Right pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destY || Bottom pixel of the centre of the teleport region.
|}

==== NONSTICK Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the non-stick region.
|-
| [[UINT16LE]] || top || Top pixel of the non-stick region.
|-
| [[UINT16LE]] || right || Right pixel of the non-stick region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the non-stick region.
|}

==== ACID Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the acid region.
|-
| [[UINT16LE]] || top || Top pixel of the acid region.
|-
| [[UINT16LE]] || right || Right pixel of the acid region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the acid region.
|}

==== DANGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the danger region.
|-
| [[UINT16LE]] || top || Top pixel of the danger region.
|-
| [[UINT16LE]] || right || Right pixel of the danger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the danger region.
|}

==== FIELD Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the particle field.
|-
| [[UINT16LE]] || top || Top pixel of the particle field.
|-
| [[UINT16LE]] || right || Right pixel of the particle field.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the particle field.
|}

==== CURRENT Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the current region.
|-
| [[UINT16LE]] || top || Top pixel of the current region.
|-
| [[UINT16LE]] || right || Right pixel of the current region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the current region.
|-
| [[UINT16LE]] || flags || bit-0 and bit-1 : direction 00 = down, 01 = right, 10 = up, 11 = left bit-2: strength of current 0 = weak, 1 = strong bit-3: show current using dust motes 0 = no, 1 = yes
|}

==== EXITRETURN Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the return region.
|-
| [[UINT16LE]] || top || Top pixel of the return region.
|}

==== REGION Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left of region
|-
| [[UINT16LE]] || top || Top of region
|-
| [[UINT16LE]] || right || Right of region
|-
| [[UINT16LE]] || bottom || Bottom of region
|}

==== SPRITE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT8]] || layer || 0 = middleground (can interact with the player) 1=background 2=foreground (player can move behind it).
|-
| [[UINT8]] || malevolence || Bit-0: sprite will kill player in ? form Bit-1: sprite will kill player in yellow form Bit-2: sprite will kill player in ? form Bit-3: sprite will kill player in ? form.
|-
| [[UINT16LE]] || unknown || Purpose unknown
|-
| [[UINT16LE]] || mask || Sprite requires a mask graphic for transparency. If a mask is required, it will be immediately below the sprite tile in the <tt>SPR</tt> file.
|-
| [[UINT16LE]] || cleanUp || The previous sprite image needs to be removed for each frame. This is not necessary if the sprite is unmasked and never changes position.
|-
| [[UINT16LE]] || strength || How much damage the sprite can sustain. 0 = infinite, otherwise 1-127.
|-
| [[UINT16LE]] || blastArea || Size of the explosion if the sprite is destroyed. (Purely a decorative concern, there is no splash damage).
|-
| [[UINT16LE]] || active || Is the sprite in use.
|-
| [[UINT8]][2] || unknown ||
|-
| REGION || furryEntryRegion || Sprite will activate if furry enters this region.
|-
| REGION || furryExitRegion || Sprite will activate if furry leaves this region.
|-
| [[UINT8]][72] || unknown || Suspect that this region is actually populated and used as working space while the level is being played.
|-
| [[UINT16LE]] || fireRate || How often the sprite fires projectiles. 0 = none, 1-5 = low-high.
|-
| [[UINT16LE]] || fireType || How are projectiles fired. 1 = All directions slowly, 2 = Right, 3 = Left, 4 = All directions medium, 5 = All directions fast.
|-
| STATE[10] || state || 10 instances of a 158-byte structure describing the states that the sprite can be in.
|}

==== STATE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite location.
|-
| [[UINT16LE]] || top || Top pixel of the sprite location.
|-
| [[UINT16LE]] || destState || Another state to move towards. The sprite will physically move to the location of the destination state, and change state when it reaches that location.
|-
| [[UINT16LE]] || speed || Speed of sprite movement 0 = None, 1-5 = slow-fast.
|-
| [[UINT8]] || movementType || 0 = horizontal then vertical, 1 = as the crow flies, 2 = just track player vertically, no sideways movement, 3 = just track player horizontally, no up/down movement, 4 = track player, 5 = fast move??, 6 = None.
|-
| [[UINT8]] || destWaterState || Another state to change to when a requested water level change is acheived.
|-
| [[UINT8]] || gravity || If 1, the sprite falls when unsupported.
|-
| [[UINT8]] || current || Control currents. Bits 0-4 specify currents affected, Bit-5 turns currents off, Bit-6 turns currents on.
|-
| [[UINT16LE]] || activateSprite || Number of another sprite to activate.
|-
| TRIGGER || entryTrigger || A 10-byte structure that describes a trigger to change state when the player enters a region.
|-
| TRIGGER || exitTrigger || A 10-byte structure that describes a trigger to change state when the player leaves a region.
|-
| TRIGGER || spriteEntryTrigger || A 10-byte structure that describes a trigger to change state when another sprite enters a region.
|-
| TRIGGER || spriteExitTrigger || A 10-byte structure that describes a trigger to change state when another sprite leaves a region (or is destroyed).
|-
| [[UINT8]] || destroy || The sprite is destroyed (deactivated) when it enters this state.
|-
| [[UINT8]] || bounce || The sprite bounces ballistically when it hits a surface.
|-
| [[UINT16LE]] || emptyWater || Bits 0-7 speed of emptying, Bits 8-15 number of water region to empty.
|-
| [[UINT16LE]] || fillWater || Bits 0-7 speed of filling, Bits 8-15 number of water region to fill.
|-
| [[UINT8]][4] || unknown || Seems to affect the starting location of projectiles, relative to the sprite location.
|-
| [[UINT16LE]] || waterTriggerLeft || Left pixel of region for water trigger (see destWaterState field).
|-
| [[UINT16LE]] || waterTriggerTop || Top pixel of region for water trigger.
|-
| [[UINT16LE]] || waterTriggerRight || Right pixel of region for water trigger.
|-
| FRAME[10] || frame || 10 instances of an 8-byte structure describing the sprite tile location within the <tt>SPR</tt> image file
|-
| [[UINT16LE]] || animSpeed || Rate of frame change of sprite animation.
|-
| [[UINT16LE]] || cycle || Does the animation cycle repeat.
|-
| [[UINT8]] || cycleCount || Number of animation frames before changing state.
|-
| [[UINT8]] || animTriggerState || Sprite state to move to when cycleCount is reached.
|-
| [[UINT16LE]] || waterTriggerBottom || Bottom pixel of region for water trigger.
|}

==== TRIGGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || state || State to move to when triggered.
|-
| [[UINT16LE]] || left || Left pixel of the trigger region.
|-
| [[UINT16LE]] || top || Top pixel of the trigger region.
|-
| [[UINT16LE]] || right || Right pixel of the trigger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the trigger region.
|}

==== FRAME Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || top || Top pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || right || Right pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the sprite on the <tt>SPR</tt> image file.
|}

== Notes ==

There are 10 different stages in the game, and correspondingly 10 different tile and sprite sets.

The tile images for the backgrounds and landscape are stored in the <tt>DEC</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>DECORxx.LBM</tt> where xx is specified by the decFile field of the main structure.

The sprite images are stored in the <tt>SPR</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>SPRxxn</tt> where xx is specified by the decFile field of the main structure, and n is specified by the spriteMap field in the main structure.

The sprites can be of varying sizes, the FRAME data structure describes the bounding box in pixels within the sprite image file. If the sprite requires a transparency mask, then this mask will be a rectangular region with the same size as the sprite, and placed in the image file immediately below the sprite.

Within the tile image file, all the tiles are 16 × 16 pixels, tiles are referenced in the main file structure as a pair of byte coordinates, giving the X and Y position in tiles within the image file.

Certain tiles in the image file have special meaning.

The tile at 0,1 is a coin. If the player touches this tile in the level, they will gain a coin, and the tile will be swapped out for the tile at 0,0 which is always empty.

The tile at 0,2 is an extra life. If the player touches this tile in the level, they will gain an extra life, and the tile will be swapped out for the tile at 0,0.

The tile at 0,3 is a time extension. If the player touches this tile in the level, they will gain an extra 30 seconds on the clock, and the tile will be swapped out for the tile at 0,0.

All the remaining tiles on rows 0, 1 and 2 in the map are destructible tiles. The red form of the player can chew through the scenery. Chewing a tile from row 0 will cause that tile to be swapped out with the tile immediately below it in row 1. Chewing a tile from row 1 will cause that tile to be swapped out with the tile immediately below it in row 2. Chewing a tile from row 2 will cause that tile to be swapped out with the tile at 0,0, which is empty, so the player can then get through the gap created. Typically the tiles in these rows depict a gradually degraded state, you can have tiles that require more or less action to destroy them, by choosing from the three rows. Often the top row tiles are visually indistinguishable from some other non-destructible tiles in the tileset, allowing you to hide destructible tiles.

== Credits ==

This file format was reverse engineered by [[User:Carbon14|carbon14]]. 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!)

BIN Format (Fury of the Furries)

2023-07-12T09:51:40Z

Carbon14: /* EXIT Format */ correct and clarify EXIT.destination

{{Map Infobox
| Type = 2D tile-based
| Layers = 3
| Tile size = 16×16
| Viewport = 320×200
| Games =
{{Game|Fury of the Furries}}
{{Game|Pac-In-Time}}
}}

[[Fury of the Furries]] maps contain the static background and landscape for the level, collectable coins, time extensions and extra lives and destructible bricks. They also contain the 'scripting for the game play itself', this is in the form of the definitions of the sprites that interact with the player character. There are up to 10 sprites in the level, each having up to 10 states. Triggers are defined for switching between states, and for the player and or sprites to switch on or off other game-play elements.

The file itself is run-length encoded, and after decompression is always a fixed length. Generally unused elements within the game are marked by the [[UINT16LE]] value 0xFFFF.

== File Formats ==

=== RLE Compressed File Format ===

{|class="wikitable"
! Data Type || Name || Description
|-
| FOURCC || header || Appears to be a header with version number. Most files decompress to an object 25518 bytes in length, but a handful of files are shorter, and appear to be earlier versions. 
byte is the shortest, at 25432 bytes, the last entry is the time field. 
byt1 and byt3 are 25482 bytes long, and include currents. 
byt4 is 25518, it's the version seen for the vast majority of the files, and includes all the fields after the currents.
|-
| [[UINT16LE]] || length || Number of bytes in section. 
if zero then stop decompressing. 
if less than 0x7D00 then use the following length bytes from the input. 
otherwise use the following byte from the input (length - 0x7D00) times. 
 
compressed and uncompressed sections always alternate, even if this makes the packing less efficient. This means that if you have two adjacent runs, There will be at least 1 character represented as uncompressed.
|-
| ... || etc || continue with another 'length' until the final file size is achieved (25,518 bytes), or you read a 0 length.
|}

The file should end with a zero length section. i.e. two bytes of 0.

=== Uncompressed File Format ===

==== FILE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || mapWidth || Width of the playable area (in tiles) between 20 and 78.
|-
| [[UINT16LE]] || mapHeight || Height of the playable area (in tiles) between 13 and 51.

The maximum number of tiles in a game is 1024. This places constraints on the width and height.
The minimum width is 20 to match the viewport size of 320 pixels, and this constrains the height to 51 (20 × 51 = 1020).
The minimum height is 13 to match the viewport size of 200 pixels, and this constrains the width to 78 (13 × 78 = 1014).
Any other combination of width and height is possible so long as it meets these constraints.
|-
| [[UINT8]][2][78 × 51] || tileIndex || Pairs of coordinates into a [[LBM Format]] <tt>DEC</tt> file containing the tiles.
|-
| [[UINT16LE]] || decFile || The <tt>DEC</tt> file number less one. i.e. a value of 3 indicates <tt>DECOR04.LBM</tt>.
|-
| [[UINT16LE]] || startLeft || The left of the starting position for the player character, less 8 pixels.
|-
| [[UINT16LE]] || startTop || The top of the starting position for the player character.
|-
| [[UINT16LE]] || foregroundPaletteIndex || The index of the first palette entry to be regarded as foreground.

The palette for the <tt>DEC</tt> file has 16 colours and they are used in a particular order. The first is always black and is background (i.e. the player character is not blocked by this colour)
The next 4 usually dark versions of yellow, red, green and blue and are used for the shadow colour of the player character sprite, in the 4 different forms that the player can take.
The next colour (colour 5 in the palette) is the bright colour of the player character, and will be swapped out as the player changes form.
The remaining colours a chosen to suit the needs of the stage of the game (desert, forest, mountains etc).
Generally the lower colours are regarded as background, and the upper colours as foreground, and this is used in the collision detection for the player and the landscape.
|-
| EXIT[5] || exit || 5 instances of a 6-byte structure describing the exits from the level.
|-
| WATER[5] || water1 || 5 instances of an 8-byte structure describing the regions of water in the level.
|-
| TELEPORT[5] || teleport || 5 instances of an 8-byte structure describing the regions of the game that can teleport the player.
|-
| NONSTICK[5] || nonStick || 5 instances of an 8-byte structure describing regions that the player cannot attach a rope to.
|-
| ACID[5] || acid || 5 instances of an 8-byte structure describing regions that will dissolve the player if touched.
|-
| DANGER[20] || danger || 20 instances of an 8-byte structure describing regions that will explode the player if touched.
|-
| SPRITE[10] || sprite || 10 instances of a 1688-byte structure describing sprites.
|-
| [[UINT16LE]] || blueStart || 1 if the blue form of the player is available at the start of the game.
|-
| [[UINT16LE]] || greenStart || 1 if the green form of the player is available at the start of the game.
|-
| [[UINT16LE]] || redStart || 1 if the red form of the player is available at the start of the game.
|-
| [[UINT16LE]] || yellowStart || 1 if the yellow form of the player is available at the start of the game.
|-
| [[UINT8]][12] || unknown || Purpose unknown.
|-
| FIELD[5] || redField || 5 instances of an 8-byte structure describing the particle field that enables/disables the red form of the player.
|-
| FIELD[5] || greenField || 5 instances of an 8-byte structure describing the particle field that enables/disables the green form of the player.
|-
| FIELD[5] || yellowField || 5 instances of an 8-byte structure describing the particle field that enables/disables the yellow form of the player.
|-
| FIELD[5] || blueField || 5 instances of an 8-byte structure describing the particle field that enables/disables the blue form of the player.
|-
| WATER[5] || water2 || 5 further instances of an 8-byte structure describing the regions of water in the level.

Probably one of these 2 sets of water data describes regions that start full of water and can be emptied, and the others describe regions which start empty and can be filled. I'm not sure.
|-
| [[UINT8]][10] || unknown || Purpose unknown.
|-
| [[UINT8]] || waterPaletteIndex || Index of colour in palette used for water.
|-
| [[UINT8]] || airPaletteIndex || Index of colour in palette used for air.

These two palette entries can be used to modify the image as regions of water fill/empty.
|-
| [[UINT16LE]] || time || Amount of time the player has to complete the level. In 30ths of a second (The game plays at 30 fps).
|-
| CURRENT[5] || current || 5 instances of a 10-byte structure describing regions of air or water currents.
|-
| [[UINT8]] || motePaletteIndex || Index of colour in palette used for dust motes moving in currents.
|-
| [[UINT8]] || unknown || Purpose unknown.
|-
| [[UINT16LE]] || spriteMap || Index of [[LBM Format]] <tt>SPR</tt> sprite map image to use for this level. 0 = A, 1 = B.
|-
| EXITRETURN[5] || exitReturn || 5 instances of a 4-byte structure describing where the player character should re-enter the level following a side-quest.
|-
| [[UINT16LE]][5] || exitGraphic || 5 instances of and indication of how a player is depicted exiting. 0 used for the end of the level dissolves the level viewport in a swirling vortex. 1 is smooth and is used for tunnelling in multi-map levels.
|-
| [[UINT16LE]] || unknown || Seems to indicate a row in the map at which some odd palette behaviour is observed. Possibly a bug, but it could be that the intention is to shift something in the colour scheme when the player is above ground / below ground.
|}

==== EXIT Format ====

The exit region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the exit.
|-
| [[UINT16LE]] || top || top pixel of the centre of the exit.
|-
| [[UINT16LE]] || destination || Level number less one to go to next from this exit. Also the most significant bit indicates 0 = level exit, 1 = go to side quest. 
e.g. if this value is 0x8006, then go to level 7 as a side-quest.
|}

==== WATER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the water region.
|-
| [[UINT16LE]] || top || Top pixel of the water region.
|-
| [[UINT16LE]] || right || Right pixel of the water region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the water region.
|}

==== TELEPORT Format ====

The teleport region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || srcX || Left pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || srcY || Top pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destX || Right pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destY || Bottom pixel of the centre of the teleport region.
|}

==== NONSTICK Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the non-stick region.
|-
| [[UINT16LE]] || top || Top pixel of the non-stick region.
|-
| [[UINT16LE]] || right || Right pixel of the non-stick region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the non-stick region.
|}

==== ACID Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the acid region.
|-
| [[UINT16LE]] || top || Top pixel of the acid region.
|-
| [[UINT16LE]] || right || Right pixel of the acid region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the acid region.
|}

==== DANGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the danger region.
|-
| [[UINT16LE]] || top || Top pixel of the danger region.
|-
| [[UINT16LE]] || right || Right pixel of the danger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the danger region.
|}

==== FIELD Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the particle field.
|-
| [[UINT16LE]] || top || Top pixel of the particle field.
|-
| [[UINT16LE]] || right || Right pixel of the particle field.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the particle field.
|}

==== CURRENT Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the current region.
|-
| [[UINT16LE]] || top || Top pixel of the current region.
|-
| [[UINT16LE]] || right || Right pixel of the current region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the current region.
|-
| [[UINT16LE]] || flags || bit-0 and bit-1 : direction 00 = down, 01 = right, 10 = up, 11 = left bit-2: strength of current 0 = weak, 1 = strong bit-3: show current using dust motes 0 = no, 1 = yes
|}

==== EXITRETURN Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the return region.
|-
| [[UINT16LE]] || top || Top pixel of the return region.
|}

==== SPRITE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT8]] || layer || 0 = middleground (can interact with the player) 1=background 2=foreground (player can move behind it).
|-
| [[UINT8]] || malevolence || Bit-0: sprite will kill player in ? form Bit-1: sprite will kill player in yellow form Bit-2: sprite will kill player in ? form Bit-3: sprite will kill player in ? form.
|-
| [[UINT16LE]] || unknown || Purpose unknown
|-
| [[UINT16LE]] || mask || Sprite requires a mask graphic for transparency. If a mask is required, it will be immediately below the sprite tile in the <tt>SPR</tt> file.
|-
| [[UINT16LE]] || cleanUp || The previous sprite image needs to be removed for each frame. This is not necessary if the sprite is unmasked and never changes position.
|-
| [[UINT16LE]] || strength || How much damage the sprite can sustain. 0 = infinite, otherwise 1-127.
|-
| [[UINT16LE]] || blastArea || Size of the explosion if the sprite is destroyed. (Purely a decorative concern, there is no splash damage).
|-
| [[UINT16LE]] || active || Is the sprite in use.
|-
| [[UINT8]][90] || unknown || Suspect that this region is actually populated and used as working space while the level is being played.
|-
| [[UINT16LE]] || fireRate || How often the sprite fires projectiles. 0 = none, 1-5 = low-high.
|-
| [[UINT16LE]] || fireType || How are projectiles fired. 1 = All directions slowly, 2 = Right, 3 = Left, 4 = All directions medium, 5 = All directions fast.
|-
| STATE[10] || state || 10 instances of a 158-byte structure describing the states that the sprite can be in.
|}

==== STATE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite location.
|-
| [[UINT16LE]] || top || Top pixel of the sprite location.
|-
| [[UINT16LE]] || destState || Another state to move towards. The sprite will physically move to the location of the destination state, and change state when it reaches that location.
|-
| [[UINT16LE]] || speed || Speed of sprite movement 0 = None, 1-5 = slow-fast.
|-
| [[UINT8]] || movementType || 0 = horizontal then vertical, 1 = as the crow flies, 2 = just track player vertically, no sideways movement, 3 = just track player horizontally, no up/down movement, 4 = track player, 5 = fast move??, 6 = None.
|-
| [[UINT8]] || destWaterState || Another state to change to when a requested water level change is acheived.
|-
| [[UINT8]] || gravity || If 1, the sprite falls when unsupported.
|-
| [[UINT8]] || current || Control currents. Bits 0-4 specify currents affected, Bit-5 turns currents off, Bit-6 turns currents on.
|-
| [[UINT16LE]] || activateSprite || Number of another sprite to activate.
|-
| TRIGGER || entryTrigger || A 10-byte structure that describes a trigger to change state when the player enters a region.
|-
| TRIGGER || exitTrigger || A 10-byte structure that describes a trigger to change state when the player leaves a region.
|-
| TRIGGER || spriteEntryTrigger || A 10-byte structure that describes a trigger to change state when another sprite enters a region.
|-
| TRIGGER || spriteExitTrigger || A 10-byte structure that describes a trigger to change state when another sprite leaves a region (or is destroyed).
|-
| [[UINT8]] || destroy || The sprite is destroyed (deactivated) when it enters this state.
|-
| [[UINT8]] || bounce || The sprite bounces ballistically when it hits a surface.
|-
| [[UINT16LE]] || emptyWater || Bits 0-7 speed of emptying, Bits 8-15 number of water region to empty.
|-
| [[UINT16LE]] || fillWater || Bits 0-7 speed of filling, Bits 8-15 number of water region to fill.
|-
| [[UINT8]][4] || unknown || Seems to affect the starting location of projectiles, relative to the sprite location.
|-
| [[UINT16LE]] || waterTriggerLeft || Left pixel of region for water trigger (see destWaterState field).
|-
| [[UINT16LE]] || waterTriggerTop || Top pixel of region for water trigger.
|-
| [[UINT16LE]] || waterTriggerRight || Right pixel of region for water trigger.
|-
| FRAME[10] || frame || 10 instances of an 8-byte structure describing the sprite tile location within the <tt>SPR</tt> image file
|-
| [[UINT16LE]] || animSpeed || Rate of frame change of sprite animation.
|-
| [[UINT16LE]] || cycle || Does the animation cycle repeat.
|-
| [[UINT8]] || cycleCount || Number of animation frames before changing state.
|-
| [[UINT8]] || animTriggerState || Sprite state to move to when cycleCount is reached.
|-
| [[UINT16LE]] || waterTriggerBottom || Bottom pixel of region for water trigger.
|}

==== TRIGGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || state || State to move to when triggered.
|-
| [[UINT16LE]] || left || Left pixel of the trigger region.
|-
| [[UINT16LE]] || top || Top pixel of the trigger region.
|-
| [[UINT16LE]] || right || Right pixel of the trigger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the trigger region.
|}

==== FRAME Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || top || Top pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || right || Right pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the sprite on the <tt>SPR</tt> image file.
|}

== Notes ==

There are 10 different stages in the game, and correspondingly 10 different tile and sprite sets.

The tile images for the backgrounds and landscape are stored in the <tt>DEC</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>DECORxx.LBM</tt> where xx is specified by the decFile field of the main structure.

The sprite images are stored in the <tt>SPR</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>SPRxxn</tt> where xx is specified by the decFile field of the main structure, and n is specified by the spriteMap field in the main structure.

The sprites can be of varying sizes, the FRAME data structure describes the bounding box in pixels within the sprite image file. If the sprite requires a transparency mask, then this mask will be a rectangular region with the same size as the sprite, and placed in the image file immediately below the sprite.

Within the tile image file, all the tiles are 16 × 16 pixels, tiles are referenced in the main file structure as a pair of byte coordinates, giving the X and Y position in tiles within the image file.

Certain tiles in the image file have special meaning.

The tile at 0,1 is a coin. If the player touches this tile in the level, they will gain a coin, and the tile will be swapped out for the tile at 0,0 which is always empty.

The tile at 0,2 is an extra life. If the player touches this tile in the level, they will gain an extra life, and the tile will be swapped out for the tile at 0,0.

The tile at 0,3 is a time extension. If the player touches this tile in the level, they will gain an extra 30 seconds on the clock, and the tile will be swapped out for the tile at 0,0.

All the remaining tiles on rows 0, 1 and 2 in the map are destructible tiles. The red form of the player can chew through the scenery. Chewing a tile from row 0 will cause that tile to be swapped out with the tile immediately below it in row 1. Chewing a tile from row 1 will cause that tile to be swapped out with the tile immediately below it in row 2. Chewing a tile from row 2 will cause that tile to be swapped out with the tile at 0,0, which is empty, so the player can then get through the gap created. Typically the tiles in these rows depict a gradually degraded state, you can have tiles that require more or less action to destroy them, by choosing from the three rows. Often the top row tiles are visually indistinguishable from some other non-destructible tiles in the tileset, allowing you to hide destructible tiles.

== Credits ==

This file format was reverse engineered by [[User:Carbon14|carbon14]]. 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!)

File:BIN Format (Fury of the Furries).png

2023-07-07T11:59:51Z

Carbon14: Carbon14 uploaded a new version of File:BIN Format (Fury of the Furries).png

BIN Format (Fury of the Furries)

2023-07-07T11:58:00Z

Carbon14: /* RLE Compressed File Format */ Add alternating section specification

{{Map Infobox
| Type = 2D tile-based
| Layers = 3
| Tile size = 16×16
| Viewport = 320×200
| Games =
{{Game|Fury of the Furries}}
{{Game|Pac-In-Time}}
}}

[[Fury of the Furries]] maps contain the static background and landscape for the level, collectable coins, time extensions and extra lives and destructible bricks. They also contain the 'scripting for the game play itself', this is in the form of the definitions of the sprites that interact with the player character. There are up to 10 sprites in the level, each having up to 10 states. Triggers are defined for switching between states, and for the player and or sprites to switch on or off other game-play elements.

The file itself is run-length encoded, and after decompression is always a fixed length. Generally unused elements within the game are marked by the [[UINT16LE]] value 0xFFFF.

== File Formats ==

=== RLE Compressed File Format ===

{|class="wikitable"
! Data Type || Name || Description
|-
| FOURCC || header || Appears to be a header with version number. Most files decompress to an object 25518 bytes in length, but a handful of files are shorter, and appear to be earlier versions. 
byte is the shortest, at 25432 bytes, the last entry is the time field. 
byt1 and byt3 are 25482 bytes long, and include currents. 
byt4 is 25518, it's the version seen for the vast majority of the files, and includes all the fields after the currents.
|-
| [[UINT16LE]] || length || Number of bytes in section. 
if zero then stop decompressing. 
if less than 0x7D00 then use the following length bytes from the input. 
otherwise use the following byte from the input (length - 0x7D00) times. 
 
compressed and uncompressed sections always alternate, even if this makes the packing less efficient. This means that if you have two adjacent runs, There will be at least 1 character represented as uncompressed.
|-
| ... || etc || continue with another 'length' until the final file size is achieved (25,518 bytes), or you read a 0 length.
|}

The file should end with a zero length section. i.e. two bytes of 0.

=== Uncompressed File Format ===

==== FILE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || mapWidth || Width of the playable area (in tiles) between 20 and 78.
|-
| [[UINT16LE]] || mapHeight || Height of the playable area (in tiles) between 13 and 51.

The maximum number of tiles in a game is 1024. This places constraints on the width and height.
The minimum width is 20 to match the viewport size of 320 pixels, and this constrains the height to 51 (20 × 51 = 1020).
The minimum height is 13 to match the viewport size of 200 pixels, and this constrains the width to 78 (13 × 78 = 1014).
Any other combination of width and height is possible so long as it meets these constraints.
|-
| [[UINT8]][2][78 × 51] || tileIndex || Pairs of coordinates into a [[LBM Format]] <tt>DEC</tt> file containing the tiles.
|-
| [[UINT16LE]] || decFile || The <tt>DEC</tt> file number less one. i.e. a value of 3 indicates <tt>DECOR04.LBM</tt>.
|-
| [[UINT16LE]] || startLeft || The left of the starting position for the player character, less 8 pixels.
|-
| [[UINT16LE]] || startTop || The top of the starting position for the player character.
|-
| [[UINT16LE]] || foregroundPaletteIndex || The index of the first palette entry to be regarded as foreground.

The palette for the <tt>DEC</tt> file has 16 colours and they are used in a particular order. The first is always black and is background (i.e. the player character is not blocked by this colour)
The next 4 usually dark versions of yellow, red, green and blue and are used for the shadow colour of the player character sprite, in the 4 different forms that the player can take.
The next colour (colour 5 in the palette) is the bright colour of the player character, and will be swapped out as the player changes form.
The remaining colours a chosen to suit the needs of the stage of the game (desert, forest, mountains etc).
Generally the lower colours are regarded as background, and the upper colours as foreground, and this is used in the collision detection for the player and the landscape.
|-
| EXIT[5] || exit || 5 instances of a 6-byte structure describing the exits from the level.
|-
| WATER[5] || water1 || 5 instances of an 8-byte structure describing the regions of water in the level.
|-
| TELEPORT[5] || teleport || 5 instances of an 8-byte structure describing the regions of the game that can teleport the player.
|-
| NONSTICK[5] || nonStick || 5 instances of an 8-byte structure describing regions that the player cannot attach a rope to.
|-
| ACID[5] || acid || 5 instances of an 8-byte structure describing regions that will dissolve the player if touched.
|-
| DANGER[20] || danger || 20 instances of an 8-byte structure describing regions that will explode the player if touched.
|-
| SPRITE[10] || sprite || 10 instances of a 1688-byte structure describing sprites.
|-
| [[UINT16LE]] || blueStart || 1 if the blue form of the player is available at the start of the game.
|-
| [[UINT16LE]] || greenStart || 1 if the green form of the player is available at the start of the game.
|-
| [[UINT16LE]] || redStart || 1 if the red form of the player is available at the start of the game.
|-
| [[UINT16LE]] || yellowStart || 1 if the yellow form of the player is available at the start of the game.
|-
| [[UINT8]][12] || unknown || Purpose unknown.
|-
| FIELD[5] || redField || 5 instances of an 8-byte structure describing the particle field that enables/disables the red form of the player.
|-
| FIELD[5] || greenField || 5 instances of an 8-byte structure describing the particle field that enables/disables the green form of the player.
|-
| FIELD[5] || yellowField || 5 instances of an 8-byte structure describing the particle field that enables/disables the yellow form of the player.
|-
| FIELD[5] || blueField || 5 instances of an 8-byte structure describing the particle field that enables/disables the blue form of the player.
|-
| WATER[5] || water2 || 5 further instances of an 8-byte structure describing the regions of water in the level.

Probably one of these 2 sets of water data describes regions that start full of water and can be emptied, and the others describe regions which start empty and can be filled. I'm not sure.
|-
| [[UINT8]][10] || unknown || Purpose unknown.
|-
| [[UINT8]] || waterPaletteIndex || Index of colour in palette used for water.
|-
| [[UINT8]] || airPaletteIndex || Index of colour in palette used for air.

These two palette entries can be used to modify the image as regions of water fill/empty.
|-
| [[UINT16LE]] || time || Amount of time the player has to complete the level. In 30ths of a second (The game plays at 30 fps).
|-
| CURRENT[5] || current || 5 instances of a 10-byte structure describing regions of air or water currents.
|-
| [[UINT8]] || motePaletteIndex || Index of colour in palette used for dust motes moving in currents.
|-
| [[UINT8]] || unknown || Purpose unknown.
|-
| [[UINT16LE]] || spriteMap || Index of [[LBM Format]] <tt>SPR</tt> sprite map image to use for this level. 0 = A, 1 = B.
|-
| EXITRETURN[5] || exitReturn || 5 instances of a 4-byte structure describing where the player character should re-enter the level following a side-quest.
|-
| [[UINT16LE]][5] || exitGraphic || 5 instances of and indication of how a player is depicted exiting. 0 used for the end of the level dissolves the level viewport in a swirling vortex. 1 is smooth and is used for tunnelling in multi-map levels.
|-
| [[UINT16LE]] || unknown || Seems to indicate a row in the map at which some odd palette behaviour is observed. Possibly a bug, but it could be that the intention is to shift something in the colour scheme when the player is above ground / below ground.
|}

==== EXIT Format ====

The exit region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the exit.
|-
| [[UINT16LE]] || top || top pixel of the centre of the exit.
|-
| [[UINT16LE]] || destination || Level number to go to next from this exit. Also the most significant bit indicates 0 = level exit, 1 = go to side quest.
|}

==== WATER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the water region.
|-
| [[UINT16LE]] || top || Top pixel of the water region.
|-
| [[UINT16LE]] || right || Right pixel of the water region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the water region.
|}

==== TELEPORT Format ====

The teleport region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || srcX || Left pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || srcY || Top pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destX || Right pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destY || Bottom pixel of the centre of the teleport region.
|}

==== NONSTICK Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the non-stick region.
|-
| [[UINT16LE]] || top || Top pixel of the non-stick region.
|-
| [[UINT16LE]] || right || Right pixel of the non-stick region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the non-stick region.
|}

==== ACID Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the acid region.
|-
| [[UINT16LE]] || top || Top pixel of the acid region.
|-
| [[UINT16LE]] || right || Right pixel of the acid region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the acid region.
|}

==== DANGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the danger region.
|-
| [[UINT16LE]] || top || Top pixel of the danger region.
|-
| [[UINT16LE]] || right || Right pixel of the danger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the danger region.
|}

==== FIELD Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the particle field.
|-
| [[UINT16LE]] || top || Top pixel of the particle field.
|-
| [[UINT16LE]] || right || Right pixel of the particle field.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the particle field.
|}

==== CURRENT Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the current region.
|-
| [[UINT16LE]] || top || Top pixel of the current region.
|-
| [[UINT16LE]] || right || Right pixel of the current region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the current region.
|-
| [[UINT16LE]] || flags || bit-0 and bit-1 : direction 00 = down, 01 = right, 10 = up, 11 = left bit-2: strength of current 0 = weak, 1 = strong bit-3: show current using dust motes 0 = no, 1 = yes
|}

==== EXITRETURN Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the return region.
|-
| [[UINT16LE]] || top || Top pixel of the return region.
|}

==== SPRITE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT8]] || layer || 0 = middleground (can interact with the player) 1=background 2=foreground (player can move behind it).
|-
| [[UINT8]] || malevolence || Bit-0: sprite will kill player in ? form Bit-1: sprite will kill player in yellow form Bit-2: sprite will kill player in ? form Bit-3: sprite will kill player in ? form.
|-
| [[UINT16LE]] || unknown || Purpose unknown
|-
| [[UINT16LE]] || mask || Sprite requires a mask graphic for transparency. If a mask is required, it will be immediately below the sprite tile in the <tt>SPR</tt> file.
|-
| [[UINT16LE]] || cleanUp || The previous sprite image needs to be removed for each frame. This is not necessary if the sprite is unmasked and never changes position.
|-
| [[UINT16LE]] || strength || How much damage the sprite can sustain. 0 = infinite, otherwise 1-127.
|-
| [[UINT16LE]] || blastArea || Size of the explosion if the sprite is destroyed. (Purely a decorative concern, there is no splash damage).
|-
| [[UINT16LE]] || active || Is the sprite in use.
|-
| [[UINT8]][90] || unknown || Suspect that this region is actually populated and used as working space while the level is being played.
|-
| [[UINT16LE]] || fireRate || How often the sprite fires projectiles. 0 = none, 1-5 = low-high.
|-
| [[UINT16LE]] || fireType || How are projectiles fired. 1 = All directions slowly, 2 = Right, 3 = Left, 4 = All directions medium, 5 = All directions fast.
|-
| STATE[10] || state || 10 instances of a 158-byte structure describing the states that the sprite can be in.
|}

==== STATE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite location.
|-
| [[UINT16LE]] || top || Top pixel of the sprite location.
|-
| [[UINT16LE]] || destState || Another state to move towards. The sprite will physically move to the location of the destination state, and change state when it reaches that location.
|-
| [[UINT16LE]] || speed || Speed of sprite movement 0 = None, 1-5 = slow-fast.
|-
| [[UINT8]] || movementType || 0 = horizontal then vertical, 1 = as the crow flies, 2 = just track player vertically, no sideways movement, 3 = just track player horizontally, no up/down movement, 4 = track player, 5 = fast move??, 6 = None.
|-
| [[UINT8]] || destWaterState || Another state to change to when a requested water level change is acheived.
|-
| [[UINT8]] || gravity || If 1, the sprite falls when unsupported.
|-
| [[UINT8]] || current || Control currents. Bits 0-4 specify currents affected, Bit-5 turns currents off, Bit-6 turns currents on.
|-
| [[UINT16LE]] || activateSprite || Number of another sprite to activate.
|-
| TRIGGER || entryTrigger || A 10-byte structure that describes a trigger to change state when the player enters a region.
|-
| TRIGGER || exitTrigger || A 10-byte structure that describes a trigger to change state when the player leaves a region.
|-
| TRIGGER || spriteEntryTrigger || A 10-byte structure that describes a trigger to change state when another sprite enters a region.
|-
| TRIGGER || spriteExitTrigger || A 10-byte structure that describes a trigger to change state when another sprite leaves a region (or is destroyed).
|-
| [[UINT8]] || destroy || The sprite is destroyed (deactivated) when it enters this state.
|-
| [[UINT8]] || bounce || The sprite bounces ballistically when it hits a surface.
|-
| [[UINT16LE]] || emptyWater || Bits 0-7 speed of emptying, Bits 8-15 number of water region to empty.
|-
| [[UINT16LE]] || fillWater || Bits 0-7 speed of filling, Bits 8-15 number of water region to fill.
|-
| [[UINT8]][4] || unknown || Seems to affect the starting location of projectiles, relative to the sprite location.
|-
| [[UINT16LE]] || waterTriggerLeft || Left pixel of region for water trigger (see destWaterState field).
|-
| [[UINT16LE]] || waterTriggerTop || Top pixel of region for water trigger.
|-
| [[UINT16LE]] || waterTriggerRight || Right pixel of region for water trigger.
|-
| FRAME[10] || frame || 10 instances of an 8-byte structure describing the sprite tile location within the <tt>SPR</tt> image file
|-
| [[UINT16LE]] || animSpeed || Rate of frame change of sprite animation.
|-
| [[UINT16LE]] || cycle || Does the animation cycle repeat.
|-
| [[UINT8]] || cycleCount || Number of animation frames before changing state.
|-
| [[UINT8]] || animTriggerState || Sprite state to move to when cycleCount is reached.
|-
| [[UINT16LE]] || waterTriggerBottom || Bottom pixel of region for water trigger.
|}

==== TRIGGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || state || State to move to when triggered.
|-
| [[UINT16LE]] || left || Left pixel of the trigger region.
|-
| [[UINT16LE]] || top || Top pixel of the trigger region.
|-
| [[UINT16LE]] || right || Right pixel of the trigger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the trigger region.
|}

==== FRAME Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || top || Top pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || right || Right pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the sprite on the <tt>SPR</tt> image file.
|}

== Notes ==

There are 10 different stages in the game, and correspondingly 10 different tile and sprite sets.

The tile images for the backgrounds and landscape are stored in the <tt>DEC</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>DECORxx.LBM</tt> where xx is specified by the decFile field of the main structure.

The sprite images are stored in the <tt>SPR</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>SPRxxn</tt> where xx is specified by the decFile field of the main structure, and n is specified by the spriteMap field in the main structure.

The sprites can be of varying sizes, the FRAME data structure describes the bounding box in pixels within the sprite image file. If the sprite requires a transparency mask, then this mask will be a rectangular region with the same size as the sprite, and placed in the image file immediately below the sprite.

Within the tile image file, all the tiles are 16 × 16 pixels, tiles are referenced in the main file structure as a pair of byte coordinates, giving the X and Y position in tiles within the image file.

Certain tiles in the image file have special meaning.

The tile at 0,1 is a coin. If the player touches this tile in the level, they will gain a coin, and the tile will be swapped out for the tile at 0,0 which is always empty.

The tile at 0,2 is an extra life. If the player touches this tile in the level, they will gain an extra life, and the tile will be swapped out for the tile at 0,0.

The tile at 0,3 is a time extension. If the player touches this tile in the level, they will gain an extra 30 seconds on the clock, and the tile will be swapped out for the tile at 0,0.

All the remaining tiles on rows 0, 1 and 2 in the map are destructible tiles. The red form of the player can chew through the scenery. Chewing a tile from row 0 will cause that tile to be swapped out with the tile immediately below it in row 1. Chewing a tile from row 1 will cause that tile to be swapped out with the tile immediately below it in row 2. Chewing a tile from row 2 will cause that tile to be swapped out with the tile at 0,0, which is empty, so the player can then get through the gap created. Typically the tiles in these rows depict a gradually degraded state, you can have tiles that require more or less action to destroy them, by choosing from the three rows. Often the top row tiles are visually indistinguishable from some other non-destructible tiles in the tileset, allowing you to hide destructible tiles.

== Credits ==

This file format was reverse engineered by [[User:Carbon14|carbon14]]. 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!)

BIN Format (Fury of the Furries)

2023-07-07T11:00:48Z

Carbon14: /* RLE Compressed File Format */ Add detail of zero byte ending.

{{Map Infobox
| Type = 2D tile-based
| Layers = 3
| Tile size = 16×16
| Viewport = 320×200
| Games =
{{Game|Fury of the Furries}}
{{Game|Pac-In-Time}}
}}

[[Fury of the Furries]] maps contain the static background and landscape for the level, collectable coins, time extensions and extra lives and destructible bricks. They also contain the 'scripting for the game play itself', this is in the form of the definitions of the sprites that interact with the player character. There are up to 10 sprites in the level, each having up to 10 states. Triggers are defined for switching between states, and for the player and or sprites to switch on or off other game-play elements.

The file itself is run-length encoded, and after decompression is always a fixed length. Generally unused elements within the game are marked by the [[UINT16LE]] value 0xFFFF.

== File Formats ==

=== RLE Compressed File Format ===

{|class="wikitable"
! Data Type || Name || Description
|-
| FOURCC || header || Appears to be a header with version number. Most files decompress to an object 25518 bytes in length, but a handful of files are shorter, and appear to be earlier versions. 
byte is the shortest, at 25432 bytes, the last entry is the time field. 
byt1 and byt3 are 25482 bytes long, and include currents. 
byt4 is 25518, it's the version seen for the vast majority of the files, and includes all the fields after the currents.
|-
| [[UINT16LE]] || uncompressedLength || Number of bytes in section. 
if zero then stop decompressing. 
if less than 0x7D00 then use the following uncompressedLength bytes from the input. 
otherwise use the following byte from the input (uncompressedLength - 0x7D00) times.
|-
| ... || etc || continue with another 'uncompressedLength' until the final file size is achieved (25,518 bytes), or you read a 0 uncompressedLength.
|}

The file should end with a zero length section. i.e. two bytes of 0.

=== Uncompressed File Format ===

==== FILE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || mapWidth || Width of the playable area (in tiles) between 20 and 78.
|-
| [[UINT16LE]] || mapHeight || Height of the playable area (in tiles) between 13 and 51.

The maximum number of tiles in a game is 1024. This places constraints on the width and height.
The minimum width is 20 to match the viewport size of 320 pixels, and this constrains the height to 51 (20 × 51 = 1020).
The minimum height is 13 to match the viewport size of 200 pixels, and this constrains the width to 78 (13 × 78 = 1014).
Any other combination of width and height is possible so long as it meets these constraints.
|-
| [[UINT8]][2][78 × 51] || tileIndex || Pairs of coordinates into a [[LBM Format]] <tt>DEC</tt> file containing the tiles.
|-
| [[UINT16LE]] || decFile || The <tt>DEC</tt> file number less one. i.e. a value of 3 indicates <tt>DECOR04.LBM</tt>.
|-
| [[UINT16LE]] || startLeft || The left of the starting position for the player character, less 8 pixels.
|-
| [[UINT16LE]] || startTop || The top of the starting position for the player character.
|-
| [[UINT16LE]] || foregroundPaletteIndex || The index of the first palette entry to be regarded as foreground.

The palette for the <tt>DEC</tt> file has 16 colours and they are used in a particular order. The first is always black and is background (i.e. the player character is not blocked by this colour)
The next 4 usually dark versions of yellow, red, green and blue and are used for the shadow colour of the player character sprite, in the 4 different forms that the player can take.
The next colour (colour 5 in the palette) is the bright colour of the player character, and will be swapped out as the player changes form.
The remaining colours a chosen to suit the needs of the stage of the game (desert, forest, mountains etc).
Generally the lower colours are regarded as background, and the upper colours as foreground, and this is used in the collision detection for the player and the landscape.
|-
| EXIT[5] || exit || 5 instances of a 6-byte structure describing the exits from the level.
|-
| WATER[5] || water1 || 5 instances of an 8-byte structure describing the regions of water in the level.
|-
| TELEPORT[5] || teleport || 5 instances of an 8-byte structure describing the regions of the game that can teleport the player.
|-
| NONSTICK[5] || nonStick || 5 instances of an 8-byte structure describing regions that the player cannot attach a rope to.
|-
| ACID[5] || acid || 5 instances of an 8-byte structure describing regions that will dissolve the player if touched.
|-
| DANGER[20] || danger || 20 instances of an 8-byte structure describing regions that will explode the player if touched.
|-
| SPRITE[10] || sprite || 10 instances of a 1688-byte structure describing sprites.
|-
| [[UINT16LE]] || blueStart || 1 if the blue form of the player is available at the start of the game.
|-
| [[UINT16LE]] || greenStart || 1 if the green form of the player is available at the start of the game.
|-
| [[UINT16LE]] || redStart || 1 if the red form of the player is available at the start of the game.
|-
| [[UINT16LE]] || yellowStart || 1 if the yellow form of the player is available at the start of the game.
|-
| [[UINT8]][12] || unknown || Purpose unknown.
|-
| FIELD[5] || redField || 5 instances of an 8-byte structure describing the particle field that enables/disables the red form of the player.
|-
| FIELD[5] || greenField || 5 instances of an 8-byte structure describing the particle field that enables/disables the green form of the player.
|-
| FIELD[5] || yellowField || 5 instances of an 8-byte structure describing the particle field that enables/disables the yellow form of the player.
|-
| FIELD[5] || blueField || 5 instances of an 8-byte structure describing the particle field that enables/disables the blue form of the player.
|-
| WATER[5] || water2 || 5 further instances of an 8-byte structure describing the regions of water in the level.

Probably one of these 2 sets of water data describes regions that start full of water and can be emptied, and the others describe regions which start empty and can be filled. I'm not sure.
|-
| [[UINT8]][10] || unknown || Purpose unknown.
|-
| [[UINT8]] || waterPaletteIndex || Index of colour in palette used for water.
|-
| [[UINT8]] || airPaletteIndex || Index of colour in palette used for air.

These two palette entries can be used to modify the image as regions of water fill/empty.
|-
| [[UINT16LE]] || time || Amount of time the player has to complete the level. In 30ths of a second (The game plays at 30 fps).
|-
| CURRENT[5] || current || 5 instances of a 10-byte structure describing regions of air or water currents.
|-
| [[UINT8]] || motePaletteIndex || Index of colour in palette used for dust motes moving in currents.
|-
| [[UINT8]] || unknown || Purpose unknown.
|-
| [[UINT16LE]] || spriteMap || Index of [[LBM Format]] <tt>SPR</tt> sprite map image to use for this level. 0 = A, 1 = B.
|-
| EXITRETURN[5] || exitReturn || 5 instances of a 4-byte structure describing where the player character should re-enter the level following a side-quest.
|-
| [[UINT16LE]][5] || exitGraphic || 5 instances of and indication of how a player is depicted exiting. 0 used for the end of the level dissolves the level viewport in a swirling vortex. 1 is smooth and is used for tunnelling in multi-map levels.
|-
| [[UINT16LE]] || unknown || Seems to indicate a row in the map at which some odd palette behaviour is observed. Possibly a bug, but it could be that the intention is to shift something in the colour scheme when the player is above ground / below ground.
|}

==== EXIT Format ====

The exit region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the exit.
|-
| [[UINT16LE]] || top || top pixel of the centre of the exit.
|-
| [[UINT16LE]] || destination || Level number to go to next from this exit. Also the most significant bit indicates 0 = level exit, 1 = go to side quest.
|}

==== WATER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the water region.
|-
| [[UINT16LE]] || top || Top pixel of the water region.
|-
| [[UINT16LE]] || right || Right pixel of the water region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the water region.
|}

==== TELEPORT Format ====

The teleport region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || srcX || Left pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || srcY || Top pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destX || Right pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destY || Bottom pixel of the centre of the teleport region.
|}

==== NONSTICK Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the non-stick region.
|-
| [[UINT16LE]] || top || Top pixel of the non-stick region.
|-
| [[UINT16LE]] || right || Right pixel of the non-stick region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the non-stick region.
|}

==== ACID Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the acid region.
|-
| [[UINT16LE]] || top || Top pixel of the acid region.
|-
| [[UINT16LE]] || right || Right pixel of the acid region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the acid region.
|}

==== DANGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the danger region.
|-
| [[UINT16LE]] || top || Top pixel of the danger region.
|-
| [[UINT16LE]] || right || Right pixel of the danger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the danger region.
|}

==== FIELD Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the particle field.
|-
| [[UINT16LE]] || top || Top pixel of the particle field.
|-
| [[UINT16LE]] || right || Right pixel of the particle field.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the particle field.
|}

==== CURRENT Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the current region.
|-
| [[UINT16LE]] || top || Top pixel of the current region.
|-
| [[UINT16LE]] || right || Right pixel of the current region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the current region.
|-
| [[UINT16LE]] || flags || bit-0 and bit-1 : direction 00 = down, 01 = right, 10 = up, 11 = left bit-2: strength of current 0 = weak, 1 = strong bit-3: show current using dust motes 0 = no, 1 = yes
|}

==== EXITRETURN Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the return region.
|-
| [[UINT16LE]] || top || Top pixel of the return region.
|}

==== SPRITE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT8]] || layer || 0 = middleground (can interact with the player) 1=background 2=foreground (player can move behind it).
|-
| [[UINT8]] || malevolence || Bit-0: sprite will kill player in ? form Bit-1: sprite will kill player in yellow form Bit-2: sprite will kill player in ? form Bit-3: sprite will kill player in ? form.
|-
| [[UINT16LE]] || unknown || Purpose unknown
|-
| [[UINT16LE]] || mask || Sprite requires a mask graphic for transparency. If a mask is required, it will be immediately below the sprite tile in the <tt>SPR</tt> file.
|-
| [[UINT16LE]] || cleanUp || The previous sprite image needs to be removed for each frame. This is not necessary if the sprite is unmasked and never changes position.
|-
| [[UINT16LE]] || strength || How much damage the sprite can sustain. 0 = infinite, otherwise 1-127.
|-
| [[UINT16LE]] || blastArea || Size of the explosion if the sprite is destroyed. (Purely a decorative concern, there is no splash damage).
|-
| [[UINT16LE]] || active || Is the sprite in use.
|-
| [[UINT8]][90] || unknown || Suspect that this region is actually populated and used as working space while the level is being played.
|-
| [[UINT16LE]] || fireRate || How often the sprite fires projectiles. 0 = none, 1-5 = low-high.
|-
| [[UINT16LE]] || fireType || How are projectiles fired. 1 = All directions slowly, 2 = Right, 3 = Left, 4 = All directions medium, 5 = All directions fast.
|-
| STATE[10] || state || 10 instances of a 158-byte structure describing the states that the sprite can be in.
|}

==== STATE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite location.
|-
| [[UINT16LE]] || top || Top pixel of the sprite location.
|-
| [[UINT16LE]] || destState || Another state to move towards. The sprite will physically move to the location of the destination state, and change state when it reaches that location.
|-
| [[UINT16LE]] || speed || Speed of sprite movement 0 = None, 1-5 = slow-fast.
|-
| [[UINT8]] || movementType || 0 = horizontal then vertical, 1 = as the crow flies, 2 = just track player vertically, no sideways movement, 3 = just track player horizontally, no up/down movement, 4 = track player, 5 = fast move??, 6 = None.
|-
| [[UINT8]] || destWaterState || Another state to change to when a requested water level change is acheived.
|-
| [[UINT8]] || gravity || If 1, the sprite falls when unsupported.
|-
| [[UINT8]] || current || Control currents. Bits 0-4 specify currents affected, Bit-5 turns currents off, Bit-6 turns currents on.
|-
| [[UINT16LE]] || activateSprite || Number of another sprite to activate.
|-
| TRIGGER || entryTrigger || A 10-byte structure that describes a trigger to change state when the player enters a region.
|-
| TRIGGER || exitTrigger || A 10-byte structure that describes a trigger to change state when the player leaves a region.
|-
| TRIGGER || spriteEntryTrigger || A 10-byte structure that describes a trigger to change state when another sprite enters a region.
|-
| TRIGGER || spriteExitTrigger || A 10-byte structure that describes a trigger to change state when another sprite leaves a region (or is destroyed).
|-
| [[UINT8]] || destroy || The sprite is destroyed (deactivated) when it enters this state.
|-
| [[UINT8]] || bounce || The sprite bounces ballistically when it hits a surface.
|-
| [[UINT16LE]] || emptyWater || Bits 0-7 speed of emptying, Bits 8-15 number of water region to empty.
|-
| [[UINT16LE]] || fillWater || Bits 0-7 speed of filling, Bits 8-15 number of water region to fill.
|-
| [[UINT8]][4] || unknown || Seems to affect the starting location of projectiles, relative to the sprite location.
|-
| [[UINT16LE]] || waterTriggerLeft || Left pixel of region for water trigger (see destWaterState field).
|-
| [[UINT16LE]] || waterTriggerTop || Top pixel of region for water trigger.
|-
| [[UINT16LE]] || waterTriggerRight || Right pixel of region for water trigger.
|-
| FRAME[10] || frame || 10 instances of an 8-byte structure describing the sprite tile location within the <tt>SPR</tt> image file
|-
| [[UINT16LE]] || animSpeed || Rate of frame change of sprite animation.
|-
| [[UINT16LE]] || cycle || Does the animation cycle repeat.
|-
| [[UINT8]] || cycleCount || Number of animation frames before changing state.
|-
| [[UINT8]] || animTriggerState || Sprite state to move to when cycleCount is reached.
|-
| [[UINT16LE]] || waterTriggerBottom || Bottom pixel of region for water trigger.
|}

==== TRIGGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || state || State to move to when triggered.
|-
| [[UINT16LE]] || left || Left pixel of the trigger region.
|-
| [[UINT16LE]] || top || Top pixel of the trigger region.
|-
| [[UINT16LE]] || right || Right pixel of the trigger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the trigger region.
|}

==== FRAME Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || top || Top pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || right || Right pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the sprite on the <tt>SPR</tt> image file.
|}

== Notes ==

There are 10 different stages in the game, and correspondingly 10 different tile and sprite sets.

The tile images for the backgrounds and landscape are stored in the <tt>DEC</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>DECORxx.LBM</tt> where xx is specified by the decFile field of the main structure.

The sprite images are stored in the <tt>SPR</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>SPRxxn</tt> where xx is specified by the decFile field of the main structure, and n is specified by the spriteMap field in the main structure.

The sprites can be of varying sizes, the FRAME data structure describes the bounding box in pixels within the sprite image file. If the sprite requires a transparency mask, then this mask will be a rectangular region with the same size as the sprite, and placed in the image file immediately below the sprite.

Within the tile image file, all the tiles are 16 × 16 pixels, tiles are referenced in the main file structure as a pair of byte coordinates, giving the X and Y position in tiles within the image file.

Certain tiles in the image file have special meaning.

The tile at 0,1 is a coin. If the player touches this tile in the level, they will gain a coin, and the tile will be swapped out for the tile at 0,0 which is always empty.

The tile at 0,2 is an extra life. If the player touches this tile in the level, they will gain an extra life, and the tile will be swapped out for the tile at 0,0.

The tile at 0,3 is a time extension. If the player touches this tile in the level, they will gain an extra 30 seconds on the clock, and the tile will be swapped out for the tile at 0,0.

All the remaining tiles on rows 0, 1 and 2 in the map are destructible tiles. The red form of the player can chew through the scenery. Chewing a tile from row 0 will cause that tile to be swapped out with the tile immediately below it in row 1. Chewing a tile from row 1 will cause that tile to be swapped out with the tile immediately below it in row 2. Chewing a tile from row 2 will cause that tile to be swapped out with the tile at 0,0, which is empty, so the player can then get through the gap created. Typically the tiles in these rows depict a gradually degraded state, you can have tiles that require more or less action to destroy them, by choosing from the three rows. Often the top row tiles are visually indistinguishable from some other non-destructible tiles in the tileset, allowing you to hide destructible tiles.

== Credits ==

This file format was reverse engineered by [[User:Carbon14|carbon14]]. 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!)

BIN Format (Fury of the Furries)

2023-07-07T10:56:15Z

Carbon14: /* RLE Compressed File Format */ Add discovered details of file header /version

{{Map Infobox
| Type = 2D tile-based
| Layers = 3
| Tile size = 16×16
| Viewport = 320×200
| Games =
{{Game|Fury of the Furries}}
{{Game|Pac-In-Time}}
}}

[[Fury of the Furries]] maps contain the static background and landscape for the level, collectable coins, time extensions and extra lives and destructible bricks. They also contain the 'scripting for the game play itself', this is in the form of the definitions of the sprites that interact with the player character. There are up to 10 sprites in the level, each having up to 10 states. Triggers are defined for switching between states, and for the player and or sprites to switch on or off other game-play elements.

The file itself is run-length encoded, and after decompression is always a fixed length. Generally unused elements within the game are marked by the [[UINT16LE]] value 0xFFFF.

== File Formats ==

=== RLE Compressed File Format ===

{|class="wikitable"
! Data Type || Name || Description
|-
| FOURCC || header || Appears to be a header with version number. Most files decompress to an object 25518 bytes in length, but a handful of files are shorter, and appear to be earlier versions. 
byte is the shortest, at 25432 bytes, the last entry is the time field. 
byt1 and byt3 are 25482 bytes long, and include currents. 
byt4 is 25518, it's the version seen for the vast majority of the files, and includes all the fields after the currents.
|-
| [[UINT16LE]] || uncompressedLength || Number of bytes in section. 
if zero then stop decompressing. 
if less than 0x7D00 then use the following uncompressedLength bytes from the input. 
otherwise use the following byte from the input (uncompressedLength - 0x7D00) times.
|-
| ... || etc || continue with another 'uncompressedLength' until the final file size is achieved (25,518 bytes), or you read a 0 uncompressedLength.
|}

=== Uncompressed File Format ===

==== FILE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || mapWidth || Width of the playable area (in tiles) between 20 and 78.
|-
| [[UINT16LE]] || mapHeight || Height of the playable area (in tiles) between 13 and 51.

The maximum number of tiles in a game is 1024. This places constraints on the width and height.
The minimum width is 20 to match the viewport size of 320 pixels, and this constrains the height to 51 (20 × 51 = 1020).
The minimum height is 13 to match the viewport size of 200 pixels, and this constrains the width to 78 (13 × 78 = 1014).
Any other combination of width and height is possible so long as it meets these constraints.
|-
| [[UINT8]][2][78 × 51] || tileIndex || Pairs of coordinates into a [[LBM Format]] <tt>DEC</tt> file containing the tiles.
|-
| [[UINT16LE]] || decFile || The <tt>DEC</tt> file number less one. i.e. a value of 3 indicates <tt>DECOR04.LBM</tt>.
|-
| [[UINT16LE]] || startLeft || The left of the starting position for the player character, less 8 pixels.
|-
| [[UINT16LE]] || startTop || The top of the starting position for the player character.
|-
| [[UINT16LE]] || foregroundPaletteIndex || The index of the first palette entry to be regarded as foreground.

The palette for the <tt>DEC</tt> file has 16 colours and they are used in a particular order. The first is always black and is background (i.e. the player character is not blocked by this colour)
The next 4 usually dark versions of yellow, red, green and blue and are used for the shadow colour of the player character sprite, in the 4 different forms that the player can take.
The next colour (colour 5 in the palette) is the bright colour of the player character, and will be swapped out as the player changes form.
The remaining colours a chosen to suit the needs of the stage of the game (desert, forest, mountains etc).
Generally the lower colours are regarded as background, and the upper colours as foreground, and this is used in the collision detection for the player and the landscape.
|-
| EXIT[5] || exit || 5 instances of a 6-byte structure describing the exits from the level.
|-
| WATER[5] || water1 || 5 instances of an 8-byte structure describing the regions of water in the level.
|-
| TELEPORT[5] || teleport || 5 instances of an 8-byte structure describing the regions of the game that can teleport the player.
|-
| NONSTICK[5] || nonStick || 5 instances of an 8-byte structure describing regions that the player cannot attach a rope to.
|-
| ACID[5] || acid || 5 instances of an 8-byte structure describing regions that will dissolve the player if touched.
|-
| DANGER[20] || danger || 20 instances of an 8-byte structure describing regions that will explode the player if touched.
|-
| SPRITE[10] || sprite || 10 instances of a 1688-byte structure describing sprites.
|-
| [[UINT16LE]] || blueStart || 1 if the blue form of the player is available at the start of the game.
|-
| [[UINT16LE]] || greenStart || 1 if the green form of the player is available at the start of the game.
|-
| [[UINT16LE]] || redStart || 1 if the red form of the player is available at the start of the game.
|-
| [[UINT16LE]] || yellowStart || 1 if the yellow form of the player is available at the start of the game.
|-
| [[UINT8]][12] || unknown || Purpose unknown.
|-
| FIELD[5] || redField || 5 instances of an 8-byte structure describing the particle field that enables/disables the red form of the player.
|-
| FIELD[5] || greenField || 5 instances of an 8-byte structure describing the particle field that enables/disables the green form of the player.
|-
| FIELD[5] || yellowField || 5 instances of an 8-byte structure describing the particle field that enables/disables the yellow form of the player.
|-
| FIELD[5] || blueField || 5 instances of an 8-byte structure describing the particle field that enables/disables the blue form of the player.
|-
| WATER[5] || water2 || 5 further instances of an 8-byte structure describing the regions of water in the level.

Probably one of these 2 sets of water data describes regions that start full of water and can be emptied, and the others describe regions which start empty and can be filled. I'm not sure.
|-
| [[UINT8]][10] || unknown || Purpose unknown.
|-
| [[UINT8]] || waterPaletteIndex || Index of colour in palette used for water.
|-
| [[UINT8]] || airPaletteIndex || Index of colour in palette used for air.

These two palette entries can be used to modify the image as regions of water fill/empty.
|-
| [[UINT16LE]] || time || Amount of time the player has to complete the level. In 30ths of a second (The game plays at 30 fps).
|-
| CURRENT[5] || current || 5 instances of a 10-byte structure describing regions of air or water currents.
|-
| [[UINT8]] || motePaletteIndex || Index of colour in palette used for dust motes moving in currents.
|-
| [[UINT8]] || unknown || Purpose unknown.
|-
| [[UINT16LE]] || spriteMap || Index of [[LBM Format]] <tt>SPR</tt> sprite map image to use for this level. 0 = A, 1 = B.
|-
| EXITRETURN[5] || exitReturn || 5 instances of a 4-byte structure describing where the player character should re-enter the level following a side-quest.
|-
| [[UINT16LE]][5] || exitGraphic || 5 instances of and indication of how a player is depicted exiting. 0 used for the end of the level dissolves the level viewport in a swirling vortex. 1 is smooth and is used for tunnelling in multi-map levels.
|-
| [[UINT16LE]] || unknown || Seems to indicate a row in the map at which some odd palette behaviour is observed. Possibly a bug, but it could be that the intention is to shift something in the colour scheme when the player is above ground / below ground.
|}

==== EXIT Format ====

The exit region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the exit.
|-
| [[UINT16LE]] || top || top pixel of the centre of the exit.
|-
| [[UINT16LE]] || destination || Level number to go to next from this exit. Also the most significant bit indicates 0 = level exit, 1 = go to side quest.
|}

==== WATER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the water region.
|-
| [[UINT16LE]] || top || Top pixel of the water region.
|-
| [[UINT16LE]] || right || Right pixel of the water region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the water region.
|}

==== TELEPORT Format ====

The teleport region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || srcX || Left pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || srcY || Top pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destX || Right pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destY || Bottom pixel of the centre of the teleport region.
|}

==== NONSTICK Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the non-stick region.
|-
| [[UINT16LE]] || top || Top pixel of the non-stick region.
|-
| [[UINT16LE]] || right || Right pixel of the non-stick region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the non-stick region.
|}

==== ACID Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the acid region.
|-
| [[UINT16LE]] || top || Top pixel of the acid region.
|-
| [[UINT16LE]] || right || Right pixel of the acid region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the acid region.
|}

==== DANGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the danger region.
|-
| [[UINT16LE]] || top || Top pixel of the danger region.
|-
| [[UINT16LE]] || right || Right pixel of the danger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the danger region.
|}

==== FIELD Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the particle field.
|-
| [[UINT16LE]] || top || Top pixel of the particle field.
|-
| [[UINT16LE]] || right || Right pixel of the particle field.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the particle field.
|}

==== CURRENT Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the current region.
|-
| [[UINT16LE]] || top || Top pixel of the current region.
|-
| [[UINT16LE]] || right || Right pixel of the current region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the current region.
|-
| [[UINT16LE]] || flags || bit-0 and bit-1 : direction 00 = down, 01 = right, 10 = up, 11 = left bit-2: strength of current 0 = weak, 1 = strong bit-3: show current using dust motes 0 = no, 1 = yes
|}

==== EXITRETURN Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the return region.
|-
| [[UINT16LE]] || top || Top pixel of the return region.
|}

==== SPRITE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT8]] || layer || 0 = middleground (can interact with the player) 1=background 2=foreground (player can move behind it).
|-
| [[UINT8]] || malevolence || Bit-0: sprite will kill player in ? form Bit-1: sprite will kill player in yellow form Bit-2: sprite will kill player in ? form Bit-3: sprite will kill player in ? form.
|-
| [[UINT16LE]] || unknown || Purpose unknown
|-
| [[UINT16LE]] || mask || Sprite requires a mask graphic for transparency. If a mask is required, it will be immediately below the sprite tile in the <tt>SPR</tt> file.
|-
| [[UINT16LE]] || cleanUp || The previous sprite image needs to be removed for each frame. This is not necessary if the sprite is unmasked and never changes position.
|-
| [[UINT16LE]] || strength || How much damage the sprite can sustain. 0 = infinite, otherwise 1-127.
|-
| [[UINT16LE]] || blastArea || Size of the explosion if the sprite is destroyed. (Purely a decorative concern, there is no splash damage).
|-
| [[UINT16LE]] || active || Is the sprite in use.
|-
| [[UINT8]][90] || unknown || Suspect that this region is actually populated and used as working space while the level is being played.
|-
| [[UINT16LE]] || fireRate || How often the sprite fires projectiles. 0 = none, 1-5 = low-high.
|-
| [[UINT16LE]] || fireType || How are projectiles fired. 1 = All directions slowly, 2 = Right, 3 = Left, 4 = All directions medium, 5 = All directions fast.
|-
| STATE[10] || state || 10 instances of a 158-byte structure describing the states that the sprite can be in.
|}

==== STATE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite location.
|-
| [[UINT16LE]] || top || Top pixel of the sprite location.
|-
| [[UINT16LE]] || destState || Another state to move towards. The sprite will physically move to the location of the destination state, and change state when it reaches that location.
|-
| [[UINT16LE]] || speed || Speed of sprite movement 0 = None, 1-5 = slow-fast.
|-
| [[UINT8]] || movementType || 0 = horizontal then vertical, 1 = as the crow flies, 2 = just track player vertically, no sideways movement, 3 = just track player horizontally, no up/down movement, 4 = track player, 5 = fast move??, 6 = None.
|-
| [[UINT8]] || destWaterState || Another state to change to when a requested water level change is acheived.
|-
| [[UINT8]] || gravity || If 1, the sprite falls when unsupported.
|-
| [[UINT8]] || current || Control currents. Bits 0-4 specify currents affected, Bit-5 turns currents off, Bit-6 turns currents on.
|-
| [[UINT16LE]] || activateSprite || Number of another sprite to activate.
|-
| TRIGGER || entryTrigger || A 10-byte structure that describes a trigger to change state when the player enters a region.
|-
| TRIGGER || exitTrigger || A 10-byte structure that describes a trigger to change state when the player leaves a region.
|-
| TRIGGER || spriteEntryTrigger || A 10-byte structure that describes a trigger to change state when another sprite enters a region.
|-
| TRIGGER || spriteExitTrigger || A 10-byte structure that describes a trigger to change state when another sprite leaves a region (or is destroyed).
|-
| [[UINT8]] || destroy || The sprite is destroyed (deactivated) when it enters this state.
|-
| [[UINT8]] || bounce || The sprite bounces ballistically when it hits a surface.
|-
| [[UINT16LE]] || emptyWater || Bits 0-7 speed of emptying, Bits 8-15 number of water region to empty.
|-
| [[UINT16LE]] || fillWater || Bits 0-7 speed of filling, Bits 8-15 number of water region to fill.
|-
| [[UINT8]][4] || unknown || Seems to affect the starting location of projectiles, relative to the sprite location.
|-
| [[UINT16LE]] || waterTriggerLeft || Left pixel of region for water trigger (see destWaterState field).
|-
| [[UINT16LE]] || waterTriggerTop || Top pixel of region for water trigger.
|-
| [[UINT16LE]] || waterTriggerRight || Right pixel of region for water trigger.
|-
| FRAME[10] || frame || 10 instances of an 8-byte structure describing the sprite tile location within the <tt>SPR</tt> image file
|-
| [[UINT16LE]] || animSpeed || Rate of frame change of sprite animation.
|-
| [[UINT16LE]] || cycle || Does the animation cycle repeat.
|-
| [[UINT8]] || cycleCount || Number of animation frames before changing state.
|-
| [[UINT8]] || animTriggerState || Sprite state to move to when cycleCount is reached.
|-
| [[UINT16LE]] || waterTriggerBottom || Bottom pixel of region for water trigger.
|}

==== TRIGGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || state || State to move to when triggered.
|-
| [[UINT16LE]] || left || Left pixel of the trigger region.
|-
| [[UINT16LE]] || top || Top pixel of the trigger region.
|-
| [[UINT16LE]] || right || Right pixel of the trigger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the trigger region.
|}

==== FRAME Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || top || Top pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || right || Right pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the sprite on the <tt>SPR</tt> image file.
|}

== Notes ==

There are 10 different stages in the game, and correspondingly 10 different tile and sprite sets.

The tile images for the backgrounds and landscape are stored in the <tt>DEC</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>DECORxx.LBM</tt> where xx is specified by the decFile field of the main structure.

The sprite images are stored in the <tt>SPR</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>SPRxxn</tt> where xx is specified by the decFile field of the main structure, and n is specified by the spriteMap field in the main structure.

The sprites can be of varying sizes, the FRAME data structure describes the bounding box in pixels within the sprite image file. If the sprite requires a transparency mask, then this mask will be a rectangular region with the same size as the sprite, and placed in the image file immediately below the sprite.

Within the tile image file, all the tiles are 16 × 16 pixels, tiles are referenced in the main file structure as a pair of byte coordinates, giving the X and Y position in tiles within the image file.

Certain tiles in the image file have special meaning.

The tile at 0,1 is a coin. If the player touches this tile in the level, they will gain a coin, and the tile will be swapped out for the tile at 0,0 which is always empty.

The tile at 0,2 is an extra life. If the player touches this tile in the level, they will gain an extra life, and the tile will be swapped out for the tile at 0,0.

The tile at 0,3 is a time extension. If the player touches this tile in the level, they will gain an extra 30 seconds on the clock, and the tile will be swapped out for the tile at 0,0.

All the remaining tiles on rows 0, 1 and 2 in the map are destructible tiles. The red form of the player can chew through the scenery. Chewing a tile from row 0 will cause that tile to be swapped out with the tile immediately below it in row 1. Chewing a tile from row 1 will cause that tile to be swapped out with the tile immediately below it in row 2. Chewing a tile from row 2 will cause that tile to be swapped out with the tile at 0,0, which is empty, so the player can then get through the gap created. Typically the tiles in these rows depict a gradually degraded state, you can have tiles that require more or less action to destroy them, by choosing from the three rows. Often the top row tiles are visually indistinguishable from some other non-destructible tiles in the tileset, allowing you to hide destructible tiles.

== Credits ==

This file format was reverse engineered by [[User:Carbon14|carbon14]]. 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!)

File:BIN Format (Fury of the Furries).png

2023-07-05T13:57:17Z

Carbon14:

BIN Format (Fury of the Furries)

2023-07-03T15:14:38Z

Carbon14: /* RLE Compressed File Format */

{{Map Infobox
| Type = 2D tile-based
| Layers = 3
| Tile size = 16×16
| Viewport = 320×200
| Games =
{{Game|Fury of the Furries}}
{{Game|Pac-In-Time}}
}}

[[Fury of the Furries]] maps contain the static background and landscape for the level, collectable coins, time extensions and extra lives and destructible bricks. They also contain the 'scripting for the game play itself', this is in the form of the definitions of the sprites that interact with the player character. There are up to 10 sprites in the level, each having up to 10 states. Triggers are defined for switching between states, and for the player and or sprites to switch on or off other game-play elements.

The file itself is run-length encoded, and after decompression is always a fixed length. Generally unused elements within the game are marked by the [[UINT16LE]] value 0xFFFF.

== File Formats ==

=== RLE Compressed File Format ===

{|class="wikitable"
! Data Type || Name || Description
|-
| [[UINT32LE]] || unknown || Unknown, but possibly a format identifier, most often <tt>byt4</tt>. Sometimes <tt>byt3</tt>, <tt>byt1</tt> or <tt>byte</tt> is seen.
|-
| [[UINT16LE]] || uncompressedLength || Number of bytes in section. 
if zero then stop decompressing. 
if less than 0x7D00 then use the following uncompressedLength bytes from the input. 
otherwise use the following byte from the input (uncompressedLength - 0x7D00) times.
|-
| ... || etc || continue with another 'uncompressedLength' until the final file size is achieved (25,518 bytes), or you read a 0 uncompressedLength.
|}

=== Uncompressed File Format ===

==== FILE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || mapWidth || Width of the playable area (in tiles) between 20 and 78.
|-
| [[UINT16LE]] || mapHeight || Height of the playable area (in tiles) between 13 and 51.

The maximum number of tiles in a game is 1024. This places constraints on the width and height.
The minimum width is 20 to match the viewport size of 320 pixels, and this constrains the height to 51 (20 × 51 = 1020).
The minimum height is 13 to match the viewport size of 200 pixels, and this constrains the width to 78 (13 × 78 = 1014).
Any other combination of width and height is possible so long as it meets these constraints.
|-
| [[UINT8]][2][78 × 51] || tileIndex || Pairs of coordinates into a [[LBM Format]] <tt>DEC</tt> file containing the tiles.
|-
| [[UINT16LE]] || decFile || The <tt>DEC</tt> file number less one. i.e. a value of 3 indicates <tt>DECOR04.LBM</tt>.
|-
| [[UINT16LE]] || startLeft || The left of the starting position for the player character, less 8 pixels.
|-
| [[UINT16LE]] || startTop || The top of the starting position for the player character.
|-
| [[UINT16LE]] || foregroundPaletteIndex || The index of the first palette entry to be regarded as foreground.

The palette for the <tt>DEC</tt> file has 16 colours and they are used in a particular order. The first is always black and is background (i.e. the player character is not blocked by this colour)
The next 4 usually dark versions of yellow, red, green and blue and are used for the shadow colour of the player character sprite, in the 4 different forms that the player can take.
The next colour (colour 5 in the palette) is the bright colour of the player character, and will be swapped out as the player changes form.
The remaining colours a chosen to suit the needs of the stage of the game (desert, forest, mountains etc).
Generally the lower colours are regarded as background, and the upper colours as foreground, and this is used in the collision detection for the player and the landscape.
|-
| EXIT[5] || exit || 5 instances of a 6-byte structure describing the exits from the level.
|-
| WATER[5] || water1 || 5 instances of an 8-byte structure describing the regions of water in the level.
|-
| TELEPORT[5] || teleport || 5 instances of an 8-byte structure describing the regions of the game that can teleport the player.
|-
| NONSTICK[5] || nonStick || 5 instances of an 8-byte structure describing regions that the player cannot attach a rope to.
|-
| ACID[5] || acid || 5 instances of an 8-byte structure describing regions that will dissolve the player if touched.
|-
| DANGER[20] || danger || 20 instances of an 8-byte structure describing regions that will explode the player if touched.
|-
| SPRITE[10] || sprite || 10 instances of a 1688-byte structure describing sprites.
|-
| [[UINT16LE]] || blueStart || 1 if the blue form of the player is available at the start of the game.
|-
| [[UINT16LE]] || greenStart || 1 if the green form of the player is available at the start of the game.
|-
| [[UINT16LE]] || redStart || 1 if the red form of the player is available at the start of the game.
|-
| [[UINT16LE]] || yellowStart || 1 if the yellow form of the player is available at the start of the game.
|-
| [[UINT8]][12] || unknown || Purpose unknown.
|-
| FIELD[5] || redField || 5 instances of an 8-byte structure describing the particle field that enables/disables the red form of the player.
|-
| FIELD[5] || greenField || 5 instances of an 8-byte structure describing the particle field that enables/disables the green form of the player.
|-
| FIELD[5] || yellowField || 5 instances of an 8-byte structure describing the particle field that enables/disables the yellow form of the player.
|-
| FIELD[5] || blueField || 5 instances of an 8-byte structure describing the particle field that enables/disables the blue form of the player.
|-
| WATER[5] || water2 || 5 further instances of an 8-byte structure describing the regions of water in the level.

Probably one of these 2 sets of water data describes regions that start full of water and can be emptied, and the others describe regions which start empty and can be filled. I'm not sure.
|-
| [[UINT8]][10] || unknown || Purpose unknown.
|-
| [[UINT8]] || waterPaletteIndex || Index of colour in palette used for water.
|-
| [[UINT8]] || airPaletteIndex || Index of colour in palette used for air.

These two palette entries can be used to modify the image as regions of water fill/empty.
|-
| [[UINT16LE]] || time || Amount of time the player has to complete the level. In 30ths of a second (The game plays at 30 fps).
|-
| CURRENT[5] || current || 5 instances of a 10-byte structure describing regions of air or water currents.
|-
| [[UINT8]] || motePaletteIndex || Index of colour in palette used for dust motes moving in currents.
|-
| [[UINT8]] || unknown || Purpose unknown.
|-
| [[UINT16LE]] || spriteMap || Index of [[LBM Format]] <tt>SPR</tt> sprite map image to use for this level. 0 = A, 1 = B.
|-
| EXITRETURN[5] || exitReturn || 5 instances of a 4-byte structure describing where the player character should re-enter the level following a side-quest.
|-
| [[UINT16LE]][5] || exitGraphic || 5 instances of and indication of how a player is depicted exiting. 0 used for the end of the level dissolves the level viewport in a swirling vortex. 1 is smooth and is used for tunnelling in multi-map levels.
|-
| [[UINT16LE]] || unknown || Seems to indicate a row in the map at which some odd palette behaviour is observed. Possibly a bug, but it could be that the intention is to shift something in the colour scheme when the player is above ground / below ground.
|}

==== EXIT Format ====

The exit region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the exit.
|-
| [[UINT16LE]] || top || top pixel of the centre of the exit.
|-
| [[UINT16LE]] || destination || Level number to go to next from this exit. Also the most significant bit indicates 0 = level exit, 1 = go to side quest.
|}

==== WATER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the water region.
|-
| [[UINT16LE]] || top || Top pixel of the water region.
|-
| [[UINT16LE]] || right || Right pixel of the water region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the water region.
|}

==== TELEPORT Format ====

The teleport region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || srcX || Left pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || srcY || Top pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destX || Right pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destY || Bottom pixel of the centre of the teleport region.
|}

==== NONSTICK Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the non-stick region.
|-
| [[UINT16LE]] || top || Top pixel of the non-stick region.
|-
| [[UINT16LE]] || right || Right pixel of the non-stick region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the non-stick region.
|}

==== ACID Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the acid region.
|-
| [[UINT16LE]] || top || Top pixel of the acid region.
|-
| [[UINT16LE]] || right || Right pixel of the acid region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the acid region.
|}

==== DANGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the danger region.
|-
| [[UINT16LE]] || top || Top pixel of the danger region.
|-
| [[UINT16LE]] || right || Right pixel of the danger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the danger region.
|}

==== FIELD Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the particle field.
|-
| [[UINT16LE]] || top || Top pixel of the particle field.
|-
| [[UINT16LE]] || right || Right pixel of the particle field.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the particle field.
|}

==== CURRENT Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the current region.
|-
| [[UINT16LE]] || top || Top pixel of the current region.
|-
| [[UINT16LE]] || right || Right pixel of the current region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the current region.
|-
| [[UINT16LE]] || flags || bit-0 and bit-1 : direction 00 = down, 01 = right, 10 = up, 11 = left bit-2: strength of current 0 = weak, 1 = strong bit-3: show current using dust motes 0 = no, 1 = yes
|}

==== EXITRETURN Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the return region.
|-
| [[UINT16LE]] || top || Top pixel of the return region.
|}

==== SPRITE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT8]] || layer || 0 = middleground (can interact with the player) 1=background 2=foreground (player can move behind it).
|-
| [[UINT8]] || malevolence || Bit-0: sprite will kill player in ? form Bit-1: sprite will kill player in yellow form Bit-2: sprite will kill player in ? form Bit-3: sprite will kill player in ? form.
|-
| [[UINT16LE]] || unknown || Purpose unknown
|-
| [[UINT16LE]] || mask || Sprite requires a mask graphic for transparency. If a mask is required, it will be immediately below the sprite tile in the <tt>SPR</tt> file.
|-
| [[UINT16LE]] || cleanUp || The previous sprite image needs to be removed for each frame. This is not necessary if the sprite is unmasked and never changes position.
|-
| [[UINT16LE]] || strength || How much damage the sprite can sustain. 0 = infinite, otherwise 1-127.
|-
| [[UINT16LE]] || blastArea || Size of the explosion if the sprite is destroyed. (Purely a decorative concern, there is no splash damage).
|-
| [[UINT16LE]] || active || Is the sprite in use.
|-
| [[UINT8]][90] || unknown || Suspect that this region is actually populated and used as working space while the level is being played.
|-
| [[UINT16LE]] || fireRate || How often the sprite fires projectiles. 0 = none, 1-5 = low-high.
|-
| [[UINT16LE]] || fireType || How are projectiles fired. 1 = All directions slowly, 2 = Right, 3 = Left, 4 = All directions medium, 5 = All directions fast.
|-
| STATE[10] || state || 10 instances of a 158-byte structure describing the states that the sprite can be in.
|}

==== STATE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite location.
|-
| [[UINT16LE]] || top || Top pixel of the sprite location.
|-
| [[UINT16LE]] || destState || Another state to move towards. The sprite will physically move to the location of the destination state, and change state when it reaches that location.
|-
| [[UINT16LE]] || speed || Speed of sprite movement 0 = None, 1-5 = slow-fast.
|-
| [[UINT8]] || movementType || 0 = horizontal then vertical, 1 = as the crow flies, 2 = just track player vertically, no sideways movement, 3 = just track player horizontally, no up/down movement, 4 = track player, 5 = fast move??, 6 = None.
|-
| [[UINT8]] || destWaterState || Another state to change to when a requested water level change is acheived.
|-
| [[UINT8]] || gravity || If 1, the sprite falls when unsupported.
|-
| [[UINT8]] || current || Control currents. Bits 0-4 specify currents affected, Bit-5 turns currents off, Bit-6 turns currents on.
|-
| [[UINT16LE]] || activateSprite || Number of another sprite to activate.
|-
| TRIGGER || entryTrigger || A 10-byte structure that describes a trigger to change state when the player enters a region.
|-
| TRIGGER || exitTrigger || A 10-byte structure that describes a trigger to change state when the player leaves a region.
|-
| TRIGGER || spriteEntryTrigger || A 10-byte structure that describes a trigger to change state when another sprite enters a region.
|-
| TRIGGER || spriteExitTrigger || A 10-byte structure that describes a trigger to change state when another sprite leaves a region (or is destroyed).
|-
| [[UINT8]] || destroy || The sprite is destroyed (deactivated) when it enters this state.
|-
| [[UINT8]] || bounce || The sprite bounces ballistically when it hits a surface.
|-
| [[UINT16LE]] || emptyWater || Bits 0-7 speed of emptying, Bits 8-15 number of water region to empty.
|-
| [[UINT16LE]] || fillWater || Bits 0-7 speed of filling, Bits 8-15 number of water region to fill.
|-
| [[UINT8]][4] || unknown || Seems to affect the starting location of projectiles, relative to the sprite location.
|-
| [[UINT16LE]] || waterTriggerLeft || Left pixel of region for water trigger (see destWaterState field).
|-
| [[UINT16LE]] || waterTriggerTop || Top pixel of region for water trigger.
|-
| [[UINT16LE]] || waterTriggerRight || Right pixel of region for water trigger.
|-
| FRAME[10] || frame || 10 instances of an 8-byte structure describing the sprite tile location within the <tt>SPR</tt> image file
|-
| [[UINT16LE]] || animSpeed || Rate of frame change of sprite animation.
|-
| [[UINT16LE]] || cycle || Does the animation cycle repeat.
|-
| [[UINT8]] || cycleCount || Number of animation frames before changing state.
|-
| [[UINT8]] || animTriggerState || Sprite state to move to when cycleCount is reached.
|-
| [[UINT16LE]] || waterTriggerBottom || Bottom pixel of region for water trigger.
|}

==== TRIGGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || state || State to move to when triggered.
|-
| [[UINT16LE]] || left || Left pixel of the trigger region.
|-
| [[UINT16LE]] || top || Top pixel of the trigger region.
|-
| [[UINT16LE]] || right || Right pixel of the trigger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the trigger region.
|}

==== FRAME Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || top || Top pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || right || Right pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the sprite on the <tt>SPR</tt> image file.
|}

== Notes ==

There are 10 different stages in the game, and correspondingly 10 different tile and sprite sets.

The tile images for the backgrounds and landscape are stored in the <tt>DEC</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>DECORxx.LBM</tt> where xx is specified by the decFile field of the main structure.

The sprite images are stored in the <tt>SPR</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>SPRxxn</tt> where xx is specified by the decFile field of the main structure, and n is specified by the spriteMap field in the main structure.

The sprites can be of varying sizes, the FRAME data structure describes the bounding box in pixels within the sprite image file. If the sprite requires a transparency mask, then this mask will be a rectangular region with the same size as the sprite, and placed in the image file immediately below the sprite.

Within the tile image file, all the tiles are 16 × 16 pixels, tiles are referenced in the main file structure as a pair of byte coordinates, giving the X and Y position in tiles within the image file.

Certain tiles in the image file have special meaning.

The tile at 0,1 is a coin. If the player touches this tile in the level, they will gain a coin, and the tile will be swapped out for the tile at 0,0 which is always empty.

The tile at 0,2 is an extra life. If the player touches this tile in the level, they will gain an extra life, and the tile will be swapped out for the tile at 0,0.

The tile at 0,3 is a time extension. If the player touches this tile in the level, they will gain an extra 30 seconds on the clock, and the tile will be swapped out for the tile at 0,0.

All the remaining tiles on rows 0, 1 and 2 in the map are destructible tiles. The red form of the player can chew through the scenery. Chewing a tile from row 0 will cause that tile to be swapped out with the tile immediately below it in row 1. Chewing a tile from row 1 will cause that tile to be swapped out with the tile immediately below it in row 2. Chewing a tile from row 2 will cause that tile to be swapped out with the tile at 0,0, which is empty, so the player can then get through the gap created. Typically the tiles in these rows depict a gradually degraded state, you can have tiles that require more or less action to destroy them, by choosing from the three rows. Often the top row tiles are visually indistinguishable from some other non-destructible tiles in the tileset, allowing you to hide destructible tiles.

== Credits ==

This file format was reverse engineered by [[User:Carbon14|carbon14]]. 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!)

BIN Format (Fury of the Furries)

2023-07-03T15:13:36Z

Carbon14: /* RLE Compressed File Format */ Correct error in compressed format description

{{Map Infobox
| Type = 2D tile-based
| Layers = 3
| Tile size = 16×16
| Viewport = 320×200
| Games =
{{Game|Fury of the Furries}}
{{Game|Pac-In-Time}}
}}

[[Fury of the Furries]] maps contain the static background and landscape for the level, collectable coins, time extensions and extra lives and destructible bricks. They also contain the 'scripting for the game play itself', this is in the form of the definitions of the sprites that interact with the player character. There are up to 10 sprites in the level, each having up to 10 states. Triggers are defined for switching between states, and for the player and or sprites to switch on or off other game-play elements.

The file itself is run-length encoded, and after decompression is always a fixed length. Generally unused elements within the game are marked by the [[UINT16LE]] value 0xFFFF.

== File Formats ==

=== RLE Compressed File Format ===

{|class="wikitable"
! Data Type || Name || Description
|-
| [[UINT32LE]] || unknown || Unknown, but possibly a format identifier, most often <tt>byt4</tt>.
|-
| [[UINT16LE]] || uncompressedLength || Number of bytes in section. 
if zero then stop decompressing. 
if less than 0x7D00 then use the following uncompressedLength bytes from the input. 
otherwise use the following byte from the input (uncompressedLength - 0x7D00) times.
|-
| ... || etc || continue with another 'uncompressedLength' until the final file size is achieved (25,518 bytes), or you read a 0 uncompressedLength.
|}

=== Uncompressed File Format ===

==== FILE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || mapWidth || Width of the playable area (in tiles) between 20 and 78.
|-
| [[UINT16LE]] || mapHeight || Height of the playable area (in tiles) between 13 and 51.

The maximum number of tiles in a game is 1024. This places constraints on the width and height.
The minimum width is 20 to match the viewport size of 320 pixels, and this constrains the height to 51 (20 × 51 = 1020).
The minimum height is 13 to match the viewport size of 200 pixels, and this constrains the width to 78 (13 × 78 = 1014).
Any other combination of width and height is possible so long as it meets these constraints.
|-
| [[UINT8]][2][78 × 51] || tileIndex || Pairs of coordinates into a [[LBM Format]] <tt>DEC</tt> file containing the tiles.
|-
| [[UINT16LE]] || decFile || The <tt>DEC</tt> file number less one. i.e. a value of 3 indicates <tt>DECOR04.LBM</tt>.
|-
| [[UINT16LE]] || startLeft || The left of the starting position for the player character, less 8 pixels.
|-
| [[UINT16LE]] || startTop || The top of the starting position for the player character.
|-
| [[UINT16LE]] || foregroundPaletteIndex || The index of the first palette entry to be regarded as foreground.

The palette for the <tt>DEC</tt> file has 16 colours and they are used in a particular order. The first is always black and is background (i.e. the player character is not blocked by this colour)
The next 4 usually dark versions of yellow, red, green and blue and are used for the shadow colour of the player character sprite, in the 4 different forms that the player can take.
The next colour (colour 5 in the palette) is the bright colour of the player character, and will be swapped out as the player changes form.
The remaining colours a chosen to suit the needs of the stage of the game (desert, forest, mountains etc).
Generally the lower colours are regarded as background, and the upper colours as foreground, and this is used in the collision detection for the player and the landscape.
|-
| EXIT[5] || exit || 5 instances of a 6-byte structure describing the exits from the level.
|-
| WATER[5] || water1 || 5 instances of an 8-byte structure describing the regions of water in the level.
|-
| TELEPORT[5] || teleport || 5 instances of an 8-byte structure describing the regions of the game that can teleport the player.
|-
| NONSTICK[5] || nonStick || 5 instances of an 8-byte structure describing regions that the player cannot attach a rope to.
|-
| ACID[5] || acid || 5 instances of an 8-byte structure describing regions that will dissolve the player if touched.
|-
| DANGER[20] || danger || 20 instances of an 8-byte structure describing regions that will explode the player if touched.
|-
| SPRITE[10] || sprite || 10 instances of a 1688-byte structure describing sprites.
|-
| [[UINT16LE]] || blueStart || 1 if the blue form of the player is available at the start of the game.
|-
| [[UINT16LE]] || greenStart || 1 if the green form of the player is available at the start of the game.
|-
| [[UINT16LE]] || redStart || 1 if the red form of the player is available at the start of the game.
|-
| [[UINT16LE]] || yellowStart || 1 if the yellow form of the player is available at the start of the game.
|-
| [[UINT8]][12] || unknown || Purpose unknown.
|-
| FIELD[5] || redField || 5 instances of an 8-byte structure describing the particle field that enables/disables the red form of the player.
|-
| FIELD[5] || greenField || 5 instances of an 8-byte structure describing the particle field that enables/disables the green form of the player.
|-
| FIELD[5] || yellowField || 5 instances of an 8-byte structure describing the particle field that enables/disables the yellow form of the player.
|-
| FIELD[5] || blueField || 5 instances of an 8-byte structure describing the particle field that enables/disables the blue form of the player.
|-
| WATER[5] || water2 || 5 further instances of an 8-byte structure describing the regions of water in the level.

Probably one of these 2 sets of water data describes regions that start full of water and can be emptied, and the others describe regions which start empty and can be filled. I'm not sure.
|-
| [[UINT8]][10] || unknown || Purpose unknown.
|-
| [[UINT8]] || waterPaletteIndex || Index of colour in palette used for water.
|-
| [[UINT8]] || airPaletteIndex || Index of colour in palette used for air.

These two palette entries can be used to modify the image as regions of water fill/empty.
|-
| [[UINT16LE]] || time || Amount of time the player has to complete the level. In 30ths of a second (The game plays at 30 fps).
|-
| CURRENT[5] || current || 5 instances of a 10-byte structure describing regions of air or water currents.
|-
| [[UINT8]] || motePaletteIndex || Index of colour in palette used for dust motes moving in currents.
|-
| [[UINT8]] || unknown || Purpose unknown.
|-
| [[UINT16LE]] || spriteMap || Index of [[LBM Format]] <tt>SPR</tt> sprite map image to use for this level. 0 = A, 1 = B.
|-
| EXITRETURN[5] || exitReturn || 5 instances of a 4-byte structure describing where the player character should re-enter the level following a side-quest.
|-
| [[UINT16LE]][5] || exitGraphic || 5 instances of and indication of how a player is depicted exiting. 0 used for the end of the level dissolves the level viewport in a swirling vortex. 1 is smooth and is used for tunnelling in multi-map levels.
|-
| [[UINT16LE]] || unknown || Seems to indicate a row in the map at which some odd palette behaviour is observed. Possibly a bug, but it could be that the intention is to shift something in the colour scheme when the player is above ground / below ground.
|}

==== EXIT Format ====

The exit region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the exit.
|-
| [[UINT16LE]] || top || top pixel of the centre of the exit.
|-
| [[UINT16LE]] || destination || Level number to go to next from this exit. Also the most significant bit indicates 0 = level exit, 1 = go to side quest.
|}

==== WATER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the water region.
|-
| [[UINT16LE]] || top || Top pixel of the water region.
|-
| [[UINT16LE]] || right || Right pixel of the water region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the water region.
|}

==== TELEPORT Format ====

The teleport region is 16 × 16 pixels.

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || srcX || Left pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || srcY || Top pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destX || Right pixel of the centre of the teleport region.
|-
| [[UINT16LE]] || destY || Bottom pixel of the centre of the teleport region.
|}

==== NONSTICK Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the non-stick region.
|-
| [[UINT16LE]] || top || Top pixel of the non-stick region.
|-
| [[UINT16LE]] || right || Right pixel of the non-stick region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the non-stick region.
|}

==== ACID Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the acid region.
|-
| [[UINT16LE]] || top || Top pixel of the acid region.
|-
| [[UINT16LE]] || right || Right pixel of the acid region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the acid region.
|}

==== DANGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the danger region.
|-
| [[UINT16LE]] || top || Top pixel of the danger region.
|-
| [[UINT16LE]] || right || Right pixel of the danger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the danger region.
|}

==== FIELD Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the particle field.
|-
| [[UINT16LE]] || top || Top pixel of the particle field.
|-
| [[UINT16LE]] || right || Right pixel of the particle field.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the particle field.
|}

==== CURRENT Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the current region.
|-
| [[UINT16LE]] || top || Top pixel of the current region.
|-
| [[UINT16LE]] || right || Right pixel of the current region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the current region.
|-
| [[UINT16LE]] || flags || bit-0 and bit-1 : direction 00 = down, 01 = right, 10 = up, 11 = left bit-2: strength of current 0 = weak, 1 = strong bit-3: show current using dust motes 0 = no, 1 = yes
|}

==== EXITRETURN Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the centre of the return region.
|-
| [[UINT16LE]] || top || Top pixel of the return region.
|}

==== SPRITE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT8]] || layer || 0 = middleground (can interact with the player) 1=background 2=foreground (player can move behind it).
|-
| [[UINT8]] || malevolence || Bit-0: sprite will kill player in ? form Bit-1: sprite will kill player in yellow form Bit-2: sprite will kill player in ? form Bit-3: sprite will kill player in ? form.
|-
| [[UINT16LE]] || unknown || Purpose unknown
|-
| [[UINT16LE]] || mask || Sprite requires a mask graphic for transparency. If a mask is required, it will be immediately below the sprite tile in the <tt>SPR</tt> file.
|-
| [[UINT16LE]] || cleanUp || The previous sprite image needs to be removed for each frame. This is not necessary if the sprite is unmasked and never changes position.
|-
| [[UINT16LE]] || strength || How much damage the sprite can sustain. 0 = infinite, otherwise 1-127.
|-
| [[UINT16LE]] || blastArea || Size of the explosion if the sprite is destroyed. (Purely a decorative concern, there is no splash damage).
|-
| [[UINT16LE]] || active || Is the sprite in use.
|-
| [[UINT8]][90] || unknown || Suspect that this region is actually populated and used as working space while the level is being played.
|-
| [[UINT16LE]] || fireRate || How often the sprite fires projectiles. 0 = none, 1-5 = low-high.
|-
| [[UINT16LE]] || fireType || How are projectiles fired. 1 = All directions slowly, 2 = Right, 3 = Left, 4 = All directions medium, 5 = All directions fast.
|-
| STATE[10] || state || 10 instances of a 158-byte structure describing the states that the sprite can be in.
|}

==== STATE Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite location.
|-
| [[UINT16LE]] || top || Top pixel of the sprite location.
|-
| [[UINT16LE]] || destState || Another state to move towards. The sprite will physically move to the location of the destination state, and change state when it reaches that location.
|-
| [[UINT16LE]] || speed || Speed of sprite movement 0 = None, 1-5 = slow-fast.
|-
| [[UINT8]] || movementType || 0 = horizontal then vertical, 1 = as the crow flies, 2 = just track player vertically, no sideways movement, 3 = just track player horizontally, no up/down movement, 4 = track player, 5 = fast move??, 6 = None.
|-
| [[UINT8]] || destWaterState || Another state to change to when a requested water level change is acheived.
|-
| [[UINT8]] || gravity || If 1, the sprite falls when unsupported.
|-
| [[UINT8]] || current || Control currents. Bits 0-4 specify currents affected, Bit-5 turns currents off, Bit-6 turns currents on.
|-
| [[UINT16LE]] || activateSprite || Number of another sprite to activate.
|-
| TRIGGER || entryTrigger || A 10-byte structure that describes a trigger to change state when the player enters a region.
|-
| TRIGGER || exitTrigger || A 10-byte structure that describes a trigger to change state when the player leaves a region.
|-
| TRIGGER || spriteEntryTrigger || A 10-byte structure that describes a trigger to change state when another sprite enters a region.
|-
| TRIGGER || spriteExitTrigger || A 10-byte structure that describes a trigger to change state when another sprite leaves a region (or is destroyed).
|-
| [[UINT8]] || destroy || The sprite is destroyed (deactivated) when it enters this state.
|-
| [[UINT8]] || bounce || The sprite bounces ballistically when it hits a surface.
|-
| [[UINT16LE]] || emptyWater || Bits 0-7 speed of emptying, Bits 8-15 number of water region to empty.
|-
| [[UINT16LE]] || fillWater || Bits 0-7 speed of filling, Bits 8-15 number of water region to fill.
|-
| [[UINT8]][4] || unknown || Seems to affect the starting location of projectiles, relative to the sprite location.
|-
| [[UINT16LE]] || waterTriggerLeft || Left pixel of region for water trigger (see destWaterState field).
|-
| [[UINT16LE]] || waterTriggerTop || Top pixel of region for water trigger.
|-
| [[UINT16LE]] || waterTriggerRight || Right pixel of region for water trigger.
|-
| FRAME[10] || frame || 10 instances of an 8-byte structure describing the sprite tile location within the <tt>SPR</tt> image file
|-
| [[UINT16LE]] || animSpeed || Rate of frame change of sprite animation.
|-
| [[UINT16LE]] || cycle || Does the animation cycle repeat.
|-
| [[UINT8]] || cycleCount || Number of animation frames before changing state.
|-
| [[UINT8]] || animTriggerState || Sprite state to move to when cycleCount is reached.
|-
| [[UINT16LE]] || waterTriggerBottom || Bottom pixel of region for water trigger.
|}

==== TRIGGER Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || state || State to move to when triggered.
|-
| [[UINT16LE]] || left || Left pixel of the trigger region.
|-
| [[UINT16LE]] || top || Top pixel of the trigger region.
|-
| [[UINT16LE]] || right || Right pixel of the trigger region.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the trigger region.
|}

==== FRAME Format ====

{|class="wikitable"}
! Data Type || Name || Description
|-
| [[UINT16LE]] || left || Left pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || top || Top pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || right || Right pixel of the sprite on the <tt>SPR</tt> image file.
|-
| [[UINT16LE]] || bottom || Bottom pixel of the sprite on the <tt>SPR</tt> image file.
|}

== Notes ==

There are 10 different stages in the game, and correspondingly 10 different tile and sprite sets.

The tile images for the backgrounds and landscape are stored in the <tt>DEC</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>DECORxx.LBM</tt> where xx is specified by the decFile field of the main structure.

The sprite images are stored in the <tt>SPR</tt> directory, in image files which are in [[LBM Format]]. These files are named <tt>SPRxxn</tt> where xx is specified by the decFile field of the main structure, and n is specified by the spriteMap field in the main structure.

The sprites can be of varying sizes, the FRAME data structure describes the bounding box in pixels within the sprite image file. If the sprite requires a transparency mask, then this mask will be a rectangular region with the same size as the sprite, and placed in the image file immediately below the sprite.

Within the tile image file, all the tiles are 16 × 16 pixels, tiles are referenced in the main file structure as a pair of byte coordinates, giving the X and Y position in tiles within the image file.

Certain tiles in the image file have special meaning.

The tile at 0,1 is a coin. If the player touches this tile in the level, they will gain a coin, and the tile will be swapped out for the tile at 0,0 which is always empty.

The tile at 0,2 is an extra life. If the player touches this tile in the level, they will gain an extra life, and the tile will be swapped out for the tile at 0,0.

The tile at 0,3 is a time extension. If the player touches this tile in the level, they will gain an extra 30 seconds on the clock, and the tile will be swapped out for the tile at 0,0.

All the remaining tiles on rows 0, 1 and 2 in the map are destructible tiles. The red form of the player can chew through the scenery. Chewing a tile from row 0 will cause that tile to be swapped out with the tile immediately below it in row 1. Chewing a tile from row 1 will cause that tile to be swapped out with the tile immediately below it in row 2. Chewing a tile from row 2 will cause that tile to be swapped out with the tile at 0,0, which is empty, so the player can then get through the gap created. Typically the tiles in these rows depict a gradually degraded state, you can have tiles that require more or less action to destroy them, by choosing from the three rows. Often the top row tiles are visually indistinguishable from some other non-destructible tiles in the tileset, allowing you to hide destructible tiles.

== Credits ==

This file format was reverse engineered by [[User:Carbon14|carbon14]]. 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!)

File:BLK Format (Fury of the Furries).png

2023-06-30T14:19:47Z

Carbon14: tileset from Fury of the Furries language selection page.

== Summary ==
tileset from Fury of the Furries language selection page.

File:Fury of the Furries.png

2023-06-30T14:12:25Z

Carbon14: Title screen for Fury of the Furries

== Summary ==
Title screen for Fury of the Furries

LBM Format

2023-06-30T14:02:23Z

Carbon14: correct typo

{{Image Infobox
| Hardware1 = CGA
| Hardware2 = EGA
| Hardware3 = VGA
| Depth = Any
| MinSize = 0×0
| MaxSize = 65535×65535
| Palette = Internal
| NumPlanes = 255
| HasTransparency = Yes
| HasHitmap = No
| Games =
{{Game|Bubble Bobble featuring Rainbow Islands}}
{{Game|Blockout}}
{{Game|The Blues Brothers}}
{{Game|Commander Keen Dreams}}
{{Game|Dangerous Dave 3}}
{{Game|Dangerous Dave 4}}
{{Game|Fury of the Furries}}
{{Game|The Settlers II}}
}}

The LBM file extension is an image file in [[Interchange File Format (IFF)]] structure to store image or palette data. Most commonly you can find these files in '''InterLeaved BitMap (ILBM) format''', but some games are using a similar, but simpler-to-use '''Planar BitMap (PBM)''' format. Both formats commonly exist under the .lbm file extension, occasionally appearing also as .bbm extension.

ILBM and PBM formats are used by games from late 80s and early 90s that either originated from Amiga platform or had their assets such as graphics done on Amiga.

== File format ==

In essence LBM files consist of a number of consecutive chunks, whose order can, to some extent, be varied. Each chunk has a different function and has the same basic format. This means that a program does not have to read or decode every chunk in a file, only the ones it wants to deal with or the ones it can understand. For example a program might use a TIME chunk to store the date and time that a file was last edited. Another program does not need to know about this and can just skip the chunk and leave it unchanged, or drop the chunk entirely, although that is not an advisable thing for a tool to do automatically.

For details on the chunk structure and how to read them, see [[Interchange File Format (IFF)]].

LBM files usually contain enough information to allow them to be displayed by an image editing program, including image dimensions, palette and pixel data. Some files were designed to act as palettes for paint programs (pixel data left blank) or to be merged into another image. This makes them much more flexible, but also much more complex than other formats such as BMP.

For LBMs the '''BMHD''' chunk and any other 'vital' chunks must appear before the '''BODY''' chunk. Any chunks appearing after '''BODY''' are considered 'extra' and many programs will leave them unread and unchanged.

{|class="wikitable"
! Type !! Name !! Description
|-
| FOURCC || chunkID || "FORM"
|-
| [[UINT32BE]] || lenChunk || Length of chunk data, in bytes. Does not include the pad byte. Will be the same as the file size minus eight bytes (this field and <tt>chunkID</tt> are not included in the count)
|-
| FOURCC || formatID || "ILBM" or "PBM "
|-
| BYTE[lenChunk - 4] || content || Actual data of the chunk, made up of the other sub-chunks below
|-
| BYTE || pad || Optional padding byte, only present if <tt>lenChunk</tt> is not a multiple of 2.
|}

There are many possible chunk types. However there are only a limited number of common chunk types used and understood by most programs, and descriptions of these follow. Again refer to [[Interchange File Format (IFF)]] for further detail about finding and handling chunks.

=== BMHD: Bitmap Header ===

The '''BMHD''' chunk specifies how the image is to be displayed and is usually the first chunk inside the '''FORM'''. It not only defines the image's height/width, but where it is drawn on the screen, how to display it in various screen resolutions and if the image is compressed. The content of this chunk is as follows:

{|class="wikitable"
! Type !! Name !! Description
|-
| [[UINT16BE]] || width || Image width, in pixels
|-
| [[UINT16BE]] || height || Image height, in pixels
|-
| [[INT16BE]] || xOrigin ||rowspan=2| Where on screen, in pixels, the image's top-left corner is. Value is usually 0,0 unless image is part of a larger image or not fullscreen.
|-
| [[INT16BE]] || yOrigin
|-
| [[UINT8]] || numPlanes || Number of planes in bitmap, 1 for monochrome, 4 for 16 color, 8 for 256 color or 0 if there is only a colormap, and no image data. (i.e. this file is just a colormap.)
|-
| [[UINT8]] || mask || 1 = masked, 2 = transparent color, 3 = lasso (for MacPaint). Mask data is not considered a bit plane.
|-
| [[UINT8]] || compression || If 0 then uncompressed. If 1 then image data is RLE compressed. Other values are theoretically possible, representing other compression methods.
|-
| [[UINT8]] || pad1 || Ignore when reading, set to 0 when writing for future compatibility
|-
| [[UINT16BE]] || transClr || Transparent colour, useful only when <tt>mask</tt> >= 2
|-
| [[UINT8]] || xAspect ||rowspan=2| Pixel aspect, a ratio width:height; used for displaying the image on a variety of different screen resolutions for 320x200 5:6 or 10:11
|-
| [[UINT8]] || yAspect
|-
| [[INT16BE]] || pageWidth ||rowspan=2| The size of the screen the image is to be displayed on, in pixels, usually 320×200
|-
| [[INT16BE]] || pageHeight
|}

=== BODY: Image data ===

The '''BODY''' chunk is usually the last chunk in a file, and the largest.

In ILBM files the '''BODY''' chunk stores the actual image data as interleaved bitplanes (and optional mask) by row. The bitplanes appear first from 1 to n, followed by the mask plane. If the image is uncompressed then each line will be made up of <code>(width + 15) / 16</code> 16-bit values (i.e. one bit per pixel, rounded up to the nearest multiple of 16-bits.) If it is compressed then each line is compressed individually and is always a multiple of 16-bits long when compressed.

The first bitplane represents the least significant bit of the color index for that pixel.

The first pixel in a row is represented by the most-significant bit of the first 16-bit value.

In PBM files the '''BODY''' chunk is simpler as uncompressed it is just a continuous stream of bytes containing image data.

==== Compression ====

If an image is compressed, each row of data (but not each bitplane) is compressed individually, including the mask data if present. The compression is a [[RLE Compression#Code|Code-based RLE Compression]]. It can be decoded as follows:

* Loop until we have [Final length] bytes worth of data (final length calculated from image size.)
* While [Decompressed data length] < [Final length]:
*# Read a byte [Value]
*# If [Value] > 128, then:
*#* Read the next byte and output it (257 - [Value]) times.
*#* Move forward 2 bytes and return to step 1.
*# Else if [Value] < 128, then:
*#* Read and output the next [value + 1] bytes
*#* Move forward [Value + 2] bytes and return to step 1.
*# Else [Value] = 128, exit the loop (stop decompressing)

For the compression routine, it's best to encode a 2 byte repeat run as a replicate run except when preceded and followed by a literal run, in which case it's best to merge the three into one literal run. Always encode >3 byte repeats as replicate runs.

=== CAMG: Amiga mode ===

A '''CAMG''' chunk is specifically for the Commodore Amiga computer. It stores a LONG "viewport mode". This lets you specify Amiga display modes like "dual playfield" and "hold and modify". It is not surprisingly rare outside of Amiga games.

{|class="wikitable"
! Type !! Name !! Description
|-
| [[UINT32BE]] || viewportMode|| bit flags; directly interpreted by Amiga hardware
|}
If you need to convert or display files that might contain meaningful CAMG chunks, see the 'Notes on working with LBM files' below.

=== CMAP: Palette ===

The '''CMAP''' chunk contains the image's palette and consists of 3-byte RGB values for each colour used. Each byte is between 0 and 255 inclusive. The chunk is <code>3 × numColours</code> bytes long. The number of colours in the palette will be <code>2 ^ numBitplanes</code>. This chunk is optional and a default palette will be used if it is not present. It is possible to have fewer entries than expected (e.g. 7 colours for a 4-plane '16 colour' bitmap for example.) Remember that if this has an odd number of colours, as per the IFF specification the chunk will be padded by one byte to make it an even number of bytes long, but the pad byte is not included in the chunk's length field.

=== CRNG: Colour range ===

The colour range chunk is 'nonstandard'. It is used by Electronic Arts' Deluxe Paint program to identify a contiguous range of colour registers or a "shade range" and colour cycling. There can be zero or more '''CRNG''' chunks in an LBM file, but all should appear before the '''BODY''' chunk. Deluxe Paint normally writes 4 CRNG chunks in an LBM when the user asks it to "Save Picture".

{|class="wikitable"
! Type !! Name !! Description
|-
| [[INT16BE]] || padding || 0x0000
|-
| [[INT16BE]] || rate || Colour cycle rate. The units are such that a rate of 60 steps per second is represented as 214 = 16384. Lower rates can be obtained by linear scaling: for 30 steps/second, rate = 8192.
|-
| [[INT16BE]] || flags || Flags which control the cycling of colours through the palette. If bit0 is 1, the colours should cycle, otherwise this colour register range is inactive and should have no effect. If bit1 is 0, the colours cycle upwards, i.e. each colour moves into the next index position in the colour map and the uppermost colour in the range moves down to the lowest position. If bit1 is 1, the colours cycle in the opposite direction. Only those colours between the '''low''' and '''high''' entries in the colour map should cycle.
|-
| [[UINT8]] || low || The index of the first entry in the colour map that is part of this range.
|-
| [[UINT8]] || high || The index of the last entry in the colour map that is part of this range.
|}

=== CCRT: Colour cycling ===

Commodore's Graphicraft program uses '''CCRT''' for ''Colour Cycling Range and Timing''. This chunk contains a CycleInfo structure. Like '''CRNG''' it is a nonstandard chunk.

{|class="wikitable"
! Type !! Name !! Description
|-
| [[INT16BE]] || direction || Cycle direction: 0=no cycling, 1=forwards, -1=backwards
|-
| [[UINT8]] || low || lowest color register selected
|-
| [[UINT8]] || high || highest color register selected
|-
| [[INT32BE]] || delaySec || Seconds between changing colors
|-
| [[INT32BE]] || delayuS || Microseconds between changing colors (added to '''delaySec''' to get total delay time)
|-
| [[INT16BE]] || padding || 0x0000
|}

The data is similar to a '''CRNG''' chunk. A program would probably only use one of these two methods of expressing colour cycle data. You could write out both if you want to communicate this information to both DeluxePaint and Graphicraft.

=== DEST: Bitplane combining ===

The optional property '''DEST''' is a way to control how to scatter zero or more source bitplanes into a deeper destination image. Some readers may ignore DEST.

{|class="wikitable"
! Type !! Name !! Description
|-
| [[UINT8]] || numPlanes || Number of bitplanes in source image
|-
| [[UINT8]] || pad1 || unused; use 0 for consistency
|-
| [[UINT16BE]] || planePick || How to pick planes to scatter them into the destination image
|-
| [[UINT16BE]] || planeOnOff || Default data for Plane Pick
|-
| [[UINT16BE]] || planeMask || Selects which bitplanes to store into
|}

The low order depth number of bits in planePick, planeOnOff, and planeMask correspond one-to-one with destination bitplanes. Bit 0 with bitplane 0, etc. (Any higher order bits should be ignored.)

"1" bits in planePick mean "put the next source bitplane into this bitplane", so the number of "1" bits should equal numPlanes. "0" bits mean "put the corresponding bit from planeOnOff into this bitplane".

Bits in planeMask gate writing to the destination bitplane: "1" bits mean "write to this bitplane" while "0" bits mean "leave this bitplane alone". The normal case (with no '''DEST''' chunk) is equivalent to <code>planePick = planeMask = (2 ^ numPlanes) - 1</code>.

Remember that color numbers are formed by pixels in the destination bitmap (depth planes deep) not in the source bitmap (numPlanes planes deep).

=== GRAB: Hotspot ===

The optional '''GRAB''' chunk locates a "handle" or "hotspot" of the image relative to its upper left corner, e.g. when used as a mouse cursor or a "paint brush". It is optional.

{|class="wikitable"
! Type !! Name !! Description
|-
| [[INT16BE]] || x || X coordinate of hotspot, in pixels relative to top-left corner of the image
|-
| [[INT16BE]] || y || Y coordinate of hotspot, in pixels relative to top-left corner of the image
|}

=== SPRT: Z-order ===

The '''SPRT''' chunk indicates that an image is intended to be a sprite. It should thus have a mask plane or transparent colour and shouldn't be fullscreen. How this is handled depends on the program using the image. The only data stored here is the sprite order, used by many programs to place the sprite in the foreground (a sprite of order 1 appears behind one of order 0, etc.) It is optional.

{|class="wikitable"
! Type !! Name !! Description
|-
| [[UINT16BE]] || order || Z-order of image (0 is closest to the foreground, larger numbers are further away/behind)
|}

=== TINY: Thumbnail ===

The '''TINY''' chunk contains a small preview image for various graphics programs, including Deluxe Paint. It is compressed and is similar in format to the '''BODY''' chunk.

{|class="wikitable"
! Type !! Name !! Description
|-
| [[UINT16BE]] || width || Thumbnail width, in pixels
|-
| [[UINT16BE]] || height || Thumbnail height, in pixels
|-
| BYTE[] || data || Pixel data, stored in exactly the same way as the '''BODY''' chunk. Use exactly the same algorithm, substituting the width and height from the '''TINY''' chunk in place of those taken from the '''BMHD''' chunk.
|}

== Notes for working with LBM ==

==== Color Maps ====

Sometimes an LBM file contains only a colour map and no image data. Often used to store a palette of colours that can be applied to an image separately. In this case the BODY chunk should be empty and the numPlanes field in the BMHD chunk will be 0.

==== Deep Images ====

Some LBM files contain 'true-colour' information rather than indexed colours. These so-called 'deep images' files have no CMAP chunk and usually have 24 or 32 bitplanes. The standard ordering for the bitplanes will put the least significant bit of the red component first:

R0 R1 R2 R3 R4 R5 R6 R7 G0 G1 G2 G3 G4 G5 G6 G7 B0 B1 B2 B3 B4 B5 B6 B7

If there are 32 bit planes, the last 8 bit planes will be an alpha channel:

R0 R1 ... R7 G0 ... G7 B0 ... B6 B7 A0 A1 A2 A3 A4 A5 A6 A7

An image containing no colour map and only 8 bitplanes may be a greyscale image:

I0 I1 I2 I3 I4 I5 I6 I7

==== Extra Half-Brite ====

If the ILBM file contains a CAMG chunk in which bit 7 is set (i.e. 0x80 in hexadecimal). The file expects to make use of the EHB (Extra Half-Brite) mode of the Amiga chipset. The colour map will have no more than 32 entries, but the image will have 6 bitplanes. The most significant bitplane should be regarded as a flag, when unset, use the lower 5 bits as an index into the colour map as usual. When the flag is set; use the lower 5 bits as an index into the colour map, but the actual colour to be used should be half as bright, which can be achieved by shifted the RGB components of the colour one bit to the right. Alternatively, create a colour map with 64 entries, and copy the lower 32 entries into the upper half, converting them to half brightness; then use all 6 bitplanes as a colour index.

PBM images cannot exist in extra half-brite mode.

==== Hold and Modify ====

If the ILBM file contains a CAMG chunk in which bit 11 is set (i.e. 0x800 in hexadecimal) the file expects to make use of the HAM (Hold-And-Modify) mode of the Amiga chipset. In HAM6 format the colour map will have up to 16 entries, but the image will have 6 (or possibly 5 bitplanes). In HAM8 format the colour map will have up to 64 entries but the image will have 8 (or possibly 7 bitplanes).

The last two bitplanes (if an odd number of bitplanes assume an extra bitplane which is always 0) are control flags which indicate how to use the first 4 (or 6) bitplanes.

{|class="wikitable"
! Control Flags !! Description
|-
| 00 || Use bitplanes 0-3 (or 0-5) as a colour map index as normal
|-
| 10 || Use the colour of the previous pixel but replace the Blue component with bits from bitplanes 0-3 (or 0-5)
|-
| 01 || Use the colour of the previous pixel but replace the Red component with bits from bitplanes 0-3 (or 0-5)
|-
| 11 || Use the colour of the previous pixel but replace the Green component with bits from bitplanes 0-3 (or 0-5)
|}

If the first pixel of a scanline is a modification pixel, then modify and use the image border colour.

Note that when using 4 bits to modify a colour component you should use the 4 bits in the upper 4 bits of the component AND in the lower 4 bits (to avoid reducing the overall colour gamut). When using 6 bits this is less important, but you can still put the 2 most significant bits of the modification bits into the least significant two bits of the colour component.

PBM images cannot exist in hold and modify mode.

== Utilities ==

Most utilities that work with LBM and BBM files are rather '''dated''', such as MacPaint or Deluxe Paint.

* [http://settlers2.net/documentation/graphics-files-lbm/ Graphics Workshop 1.1Y] from mid-90s can convert from and to all variants of LBM files; it supports a variety of other image file formats. It is dated but still works on even Windows 10 when running in Windows XP compatibility mode. There is also newer commercial version known as [http://www.mindworkshop.com/gww.html Graphics Workshop Professional] with much more modern UI (seeming to be mid-00s), which however is also dated by today's standards.

* [http://www.ultimatepaint.com/ Ultimate Paint] can read, write and display palette color cycle animations.

* [http://www.xnview.com/en/nconvert/ XnView's nconvert] is a free and '''up to date''' command line converter.

* [http://www.imageconverterplus.com/ Image Converter Plus] is a program that will convert ILBM files into any number of formats. While the full version is not free, the demo version adds a watermark that can be removed.

* Paint Shop Pro 7.04 and other older versions of PSP can read and write ILBM, but can only read PBM files. PSP7 gets a special mention as the shareware version has a bug that allows the evaluation shutdown mechanism to be skipped by simply opening a file (ie. modify shortcut to always open a file and you won't be bothered).

* [https://github.com/steffest/DPaint-js DPaint.js] is a new javascript image editor with a strong focus on Amiga formats. Modelled after the original DeluxePaint. It can be hosted locally, or there is an [https://www.stef.be/dpaint/ online version] available

* [[FuryUtils]] is a suite of tools including ImmFile which can convert some LBM files to and from windows Bmp files. Sufficient to support [[Fury of the Furries]]

== Notes ==

In the [[Commander Keen Dreams]] series of games, compressed standalone ILBM images are used for title screens, but the game does not read most of the ILBM chunks. This is because the images were edited in DeluxePaint, then imported directly into the game's files.

== Links ==

[https://web.archive.org/web/20190829195455/https://wiki.multimedia.cx/index.php/IFF IFF]

[https://web.archive.org/web/20070911223155/http://www.szonye.com/bradd/iff.html “EA IFF 85” Standard for Interchange Format Files]

LBM Format

2023-06-30T14:01:45Z

Carbon14: Added link to internally described tools FuryUtils.

{{Image Infobox
| Hardware1 = CGA
| Hardware2 = EGA
| Hardware3 = VGA
| Depth = Any
| MinSize = 0×0
| MaxSize = 65535×65535
| Palette = Internal
| NumPlanes = 255
| HasTransparency = Yes
| HasHitmap = No
| Games =
{{Game|Bubble Bobble featuring Rainbow Islands}}
{{Game|Blockout}}
{{Game|The Blues Brothers}}
{{Game|Commander Keen Dreams}}
{{Game|Dangerous Dave 3}}
{{Game|Dangerous Dave 4}}
{{Game|Fury of the Furries}}
{{Game|The Settlers II}}
}}

The LBM file extension is an image file in [[Interchange File Format (IFF)]] structure to store image or palette data. Most commonly you can find these files in '''InterLeaved BitMap (ILBM) format''', but some games are using a similar, but simpler-to-use '''Planar BitMap (PBM)''' format. Both formats commonly exist under the .lbm file extension, occasionally appearing also as .bbm extension.

ILBM and PBM formats are used by games from late 80s and early 90s that either originated from Amiga platform or had their assets such as graphics done on Amiga.

== File format ==

In essence LBM files consist of a number of consecutive chunks, whose order can, to some extent, be varied. Each chunk has a different function and has the same basic format. This means that a program does not have to read or decode every chunk in a file, only the ones it wants to deal with or the ones it can understand. For example a program might use a TIME chunk to store the date and time that a file was last edited. Another program does not need to know about this and can just skip the chunk and leave it unchanged, or drop the chunk entirely, although that is not an advisable thing for a tool to do automatically.

For details on the chunk structure and how to read them, see [[Interchange File Format (IFF)]].

LBM files usually contain enough information to allow them to be displayed by an image editing program, including image dimensions, palette and pixel data. Some files were designed to act as palettes for paint programs (pixel data left blank) or to be merged into another image. This makes them much more flexible, but also much more complex than other formats such as BMP.

For LBMs the '''BMHD''' chunk and any other 'vital' chunks must appear before the '''BODY''' chunk. Any chunks appearing after '''BODY''' are considered 'extra' and many programs will leave them unread and unchanged.

{|class="wikitable"
! Type !! Name !! Description
|-
| FOURCC || chunkID || "FORM"
|-
| [[UINT32BE]] || lenChunk || Length of chunk data, in bytes. Does not include the pad byte. Will be the same as the file size minus eight bytes (this field and <tt>chunkID</tt> are not included in the count)
|-
| FOURCC || formatID || "ILBM" or "PBM "
|-
| BYTE[lenChunk - 4] || content || Actual data of the chunk, made up of the other sub-chunks below
|-
| BYTE || pad || Optional padding byte, only present if <tt>lenChunk</tt> is not a multiple of 2.
|}

There are many possible chunk types. However there are only a limited number of common chunk types used and understood by most programs, and descriptions of these follow. Again refer to [[Interchange File Format (IFF)]] for further detail about finding and handling chunks.

=== BMHD: Bitmap Header ===

The '''BMHD''' chunk specifies how the image is to be displayed and is usually the first chunk inside the '''FORM'''. It not only defines the image's height/width, but where it is drawn on the screen, how to display it in various screen resolutions and if the image is compressed. The content of this chunk is as follows:

{|class="wikitable"
! Type !! Name !! Description
|-
| [[UINT16BE]] || width || Image width, in pixels
|-
| [[UINT16BE]] || height || Image height, in pixels
|-
| [[INT16BE]] || xOrigin ||rowspan=2| Where on screen, in pixels, the image's top-left corner is. Value is usually 0,0 unless image is part of a larger image or not fullscreen.
|-
| [[INT16BE]] || yOrigin
|-
| [[UINT8]] || numPlanes || Number of planes in bitmap, 1 for monochrome, 4 for 16 color, 8 for 256 color or 0 if there is only a colormap, and no image data. (i.e. this file is just a colormap.)
|-
| [[UINT8]] || mask || 1 = masked, 2 = transparent color, 3 = lasso (for MacPaint). Mask data is not considered a bit plane.
|-
| [[UINT8]] || compression || If 0 then uncompressed. If 1 then image data is RLE compressed. Other values are theoretically possible, representing other compression methods.
|-
| [[UINT8]] || pad1 || Ignore when reading, set to 0 when writing for future compatibility
|-
| [[UINT16BE]] || transClr || Transparent colour, useful only when <tt>mask</tt> >= 2
|-
| [[UINT8]] || xAspect ||rowspan=2| Pixel aspect, a ratio width:height; used for displaying the image on a variety of different screen resolutions for 320x200 5:6 or 10:11
|-
| [[UINT8]] || yAspect
|-
| [[INT16BE]] || pageWidth ||rowspan=2| The size of the screen the image is to be displayed on, in pixels, usually 320×200
|-
| [[INT16BE]] || pageHeight
|}

=== BODY: Image data ===

The '''BODY''' chunk is usually the last chunk in a file, and the largest.

In ILBM files the '''BODY''' chunk stores the actual image data as interleaved bitplanes (and optional mask) by row. The bitplanes appear first from 1 to n, followed by the mask plane. If the image is uncompressed then each line will be made up of <code>(width + 15) / 16</code> 16-bit values (i.e. one bit per pixel, rounded up to the nearest multiple of 16-bits.) If it is compressed then each line is compressed individually and is always a multiple of 16-bits long when compressed.

The first bitplane represents the least significant bit of the color index for that pixel.

The first pixel in a row is represented by the most-significant bit of the first 16-bit value.

In PBM files the '''BODY''' chunk is simpler as uncompressed it is just a continuous stream of bytes containing image data.

==== Compression ====

If an image is compressed, each row of data (but not each bitplane) is compressed individually, including the mask data if present. The compression is a [[RLE Compression#Code|Code-based RLE Compression]]. It can be decoded as follows:

* Loop until we have [Final length] bytes worth of data (final length calculated from image size.)
* While [Decompressed data length] < [Final length]:
*# Read a byte [Value]
*# If [Value] > 128, then:
*#* Read the next byte and output it (257 - [Value]) times.
*#* Move forward 2 bytes and return to step 1.
*# Else if [Value] < 128, then:
*#* Read and output the next [value + 1] bytes
*#* Move forward [Value + 2] bytes and return to step 1.
*# Else [Value] = 128, exit the loop (stop decompressing)

For the compression routine, it's best to encode a 2 byte repeat run as a replicate run except when preceded and followed by a literal run, in which case it's best to merge the three into one literal run. Always encode >3 byte repeats as replicate runs.

=== CAMG: Amiga mode ===

A '''CAMG''' chunk is specifically for the Commodore Amiga computer. It stores a LONG "viewport mode". This lets you specify Amiga display modes like "dual playfield" and "hold and modify". It is not surprisingly rare outside of Amiga games.

{|class="wikitable"
! Type !! Name !! Description
|-
| [[UINT32BE]] || viewportMode|| bit flags; directly interpreted by Amiga hardware
|}
If you need to convert or display files that might contain meaningful CAMG chunks, see the 'Notes on working with LBM files' below.

=== CMAP: Palette ===

The '''CMAP''' chunk contains the image's palette and consists of 3-byte RGB values for each colour used. Each byte is between 0 and 255 inclusive. The chunk is <code>3 × numColours</code> bytes long. The number of colours in the palette will be <code>2 ^ numBitplanes</code>. This chunk is optional and a default palette will be used if it is not present. It is possible to have fewer entries than expected (e.g. 7 colours for a 4-plane '16 colour' bitmap for example.) Remember that if this has an odd number of colours, as per the IFF specification the chunk will be padded by one byte to make it an even number of bytes long, but the pad byte is not included in the chunk's length field.

=== CRNG: Colour range ===

The colour range chunk is 'nonstandard'. It is used by Electronic Arts' Deluxe Paint program to identify a contiguous range of colour registers or a "shade range" and colour cycling. There can be zero or more '''CRNG''' chunks in an LBM file, but all should appear before the '''BODY''' chunk. Deluxe Paint normally writes 4 CRNG chunks in an LBM when the user asks it to "Save Picture".

{|class="wikitable"
! Type !! Name !! Description
|-
| [[INT16BE]] || padding || 0x0000
|-
| [[INT16BE]] || rate || Colour cycle rate. The units are such that a rate of 60 steps per second is represented as 214 = 16384. Lower rates can be obtained by linear scaling: for 30 steps/second, rate = 8192.
|-
| [[INT16BE]] || flags || Flags which control the cycling of colours through the palette. If bit0 is 1, the colours should cycle, otherwise this colour register range is inactive and should have no effect. If bit1 is 0, the colours cycle upwards, i.e. each colour moves into the next index position in the colour map and the uppermost colour in the range moves down to the lowest position. If bit1 is 1, the colours cycle in the opposite direction. Only those colours between the '''low''' and '''high''' entries in the colour map should cycle.
|-
| [[UINT8]] || low || The index of the first entry in the colour map that is part of this range.
|-
| [[UINT8]] || high || The index of the last entry in the colour map that is part of this range.
|}

=== CCRT: Colour cycling ===

Commodore's Graphicraft program uses '''CCRT''' for ''Colour Cycling Range and Timing''. This chunk contains a CycleInfo structure. Like '''CRNG''' it is a nonstandard chunk.

{|class="wikitable"
! Type !! Name !! Description
|-
| [[INT16BE]] || direction || Cycle direction: 0=no cycling, 1=forwards, -1=backwards
|-
| [[UINT8]] || low || lowest color register selected
|-
| [[UINT8]] || high || highest color register selected
|-
| [[INT32BE]] || delaySec || Seconds between changing colors
|-
| [[INT32BE]] || delayuS || Microseconds between changing colors (added to '''delaySec''' to get total delay time)
|-
| [[INT16BE]] || padding || 0x0000
|}

The data is similar to a '''CRNG''' chunk. A program would probably only use one of these two methods of expressing colour cycle data. You could write out both if you want to communicate this information to both DeluxePaint and Graphicraft.

=== DEST: Bitplane combining ===

The optional property '''DEST''' is a way to control how to scatter zero or more source bitplanes into a deeper destination image. Some readers may ignore DEST.

{|class="wikitable"
! Type !! Name !! Description
|-
| [[UINT8]] || numPlanes || Number of bitplanes in source image
|-
| [[UINT8]] || pad1 || unused; use 0 for consistency
|-
| [[UINT16BE]] || planePick || How to pick planes to scatter them into the destination image
|-
| [[UINT16BE]] || planeOnOff || Default data for Plane Pick
|-
| [[UINT16BE]] || planeMask || Selects which bitplanes to store into
|}

The low order depth number of bits in planePick, planeOnOff, and planeMask correspond one-to-one with destination bitplanes. Bit 0 with bitplane 0, etc. (Any higher order bits should be ignored.)

"1" bits in planePick mean "put the next source bitplane into this bitplane", so the number of "1" bits should equal numPlanes. "0" bits mean "put the corresponding bit from planeOnOff into this bitplane".

Bits in planeMask gate writing to the destination bitplane: "1" bits mean "write to this bitplane" while "0" bits mean "leave this bitplane alone". The normal case (with no '''DEST''' chunk) is equivalent to <code>planePick = planeMask = (2 ^ numPlanes) - 1</code>.

Remember that color numbers are formed by pixels in the destination bitmap (depth planes deep) not in the source bitmap (numPlanes planes deep).

=== GRAB: Hotspot ===

The optional '''GRAB''' chunk locates a "handle" or "hotspot" of the image relative to its upper left corner, e.g. when used as a mouse cursor or a "paint brush". It is optional.

{|class="wikitable"
! Type !! Name !! Description
|-
| [[INT16BE]] || x || X coordinate of hotspot, in pixels relative to top-left corner of the image
|-
| [[INT16BE]] || y || Y coordinate of hotspot, in pixels relative to top-left corner of the image
|}

=== SPRT: Z-order ===

The '''SPRT''' chunk indicates that an image is intended to be a sprite. It should thus have a mask plane or transparent colour and shouldn't be fullscreen. How this is handled depends on the program using the image. The only data stored here is the sprite order, used by many programs to place the sprite in the foreground (a sprite of order 1 appears behind one of order 0, etc.) It is optional.

{|class="wikitable"
! Type !! Name !! Description
|-
| [[UINT16BE]] || order || Z-order of image (0 is closest to the foreground, larger numbers are further away/behind)
|}

=== TINY: Thumbnail ===

The '''TINY''' chunk contains a small preview image for various graphics programs, including Deluxe Paint. It is compressed and is similar in format to the '''BODY''' chunk.

{|class="wikitable"
! Type !! Name !! Description
|-
| [[UINT16BE]] || width || Thumbnail width, in pixels
|-
| [[UINT16BE]] || height || Thumbnail height, in pixels
|-
| BYTE[] || data || Pixel data, stored in exactly the same way as the '''BODY''' chunk. Use exactly the same algorithm, substituting the width and height from the '''TINY''' chunk in place of those taken from the '''BMHD''' chunk.
|}

== Notes for working with LBM ==

==== Color Maps ====

Sometimes an LBM file contains only a colour map and no image data. Often used to store a palette of colours that can be applied to an image separately. In this case the BODY chunk should be empty and the numPlanes field in the BMHD chunk will be 0.

==== Deep Images ====

Some LBM files contain 'true-colour' information rather than indexed colours. These so-called 'deep images' files have no CMAP chunk and usually have 24 or 32 bitplanes. The standard ordering for the bitplanes will put the least significant bit of the red component first:

R0 R1 R2 R3 R4 R5 R6 R7 G0 G1 G2 G3 G4 G5 G6 G7 B0 B1 B2 B3 B4 B5 B6 B7

If there are 32 bit planes, the last 8 bit planes will be an alpha channel:

R0 R1 ... R7 G0 ... G7 B0 ... B6 B7 A0 A1 A2 A3 A4 A5 A6 A7

An image containing no colour map and only 8 bitplanes may be a greyscale image:

I0 I1 I2 I3 I4 I5 I6 I7

==== Extra Half-Brite ====

If the ILBM file contains a CAMG chunk in which bit 7 is set (i.e. 0x80 in hexadecimal). The file expects to make use of the EHB (Extra Half-Brite) mode of the Amiga chipset. The colour map will have no more than 32 entries, but the image will have 6 bitplanes. The most significant bitplane should be regarded as a flag, when unset, use the lower 5 bits as an index into the colour map as usual. When the flag is set; use the lower 5 bits as an index into the colour map, but the actual colour to be used should be half as bright, which can be achieved by shifted the RGB components of the colour one bit to the right. Alternatively, create a colour map with 64 entries, and copy the lower 32 entries into the upper half, converting them to half brightness; then use all 6 bitplanes as a colour index.

PBM images cannot exist in extra half-brite mode.

==== Hold and Modify ====

If the ILBM file contains a CAMG chunk in which bit 11 is set (i.e. 0x800 in hexadecimal) the file expects to make use of the HAM (Hold-And-Modify) mode of the Amiga chipset. In HAM6 format the colour map will have up to 16 entries, but the image will have 6 (or possibly 5 bitplanes). In HAM8 format the colour map will have up to 64 entries but the image will have 8 (or possibly 7 bitplanes).

The last two bitplanes (if an odd number of bitplanes assume an extra bitplane which is always 0) are control flags which indicate how to use the first 4 (or 6) bitplanes.

{|class="wikitable"
! Control Flags !! Description
|-
| 00 || Use bitplanes 0-3 (or 0-5) as a colour map index as normal
|-
| 10 || Use the colour of the previous pixel but replace the Blue component with bits from bitplanes 0-3 (or 0-5)
|-
| 01 || Use the colour of the previous pixel but replace the Red component with bits from bitplanes 0-3 (or 0-5)
|-
| 11 || Use the colour of the previous pixel but replace the Green component with bits from bitplanes 0-3 (or 0-5)
|}

If the first pixel of a scanline is a modification pixel, then modify and use the image border colour.

Note that when using 4 bits to modify a colour component you should use the 4 bits in the upper 4 bits of the component AND in the lower 4 bits (to avoid reducing the overall colour gamut). When using 6 bits this is less important, but you can still put the 2 most significant bits of the modification bits into the least significant two bits of the colour component.

PBM images cannot exist in hold and modify mode.

== Utilities ==

Most utilities that work with LBM and BBM files are rather '''dated''', such as MacPaint or Deluxe Paint.

* [http://settlers2.net/documentation/graphics-files-lbm/ Graphics Workshop 1.1Y] from mid-90s can convert from and to all variants of LBM files; it supports a variety of other image file formats. It is dated but still works on even Windows 10 when running in Windows XP compatibility mode. There is also newer commercial version known as [http://www.mindworkshop.com/gww.html Graphics Workshop Professional] with much more modern UI (seeming to be mid-00s), which however is also dated by today's standards.

* [http://www.ultimatepaint.com/ Ultimate Paint] can read, write and display palette color cycle animations.

* [http://www.xnview.com/en/nconvert/ XnView's nconvert] is a free and '''up to date''' command line converter.

* [http://www.imageconverterplus.com/ Image Converter Plus] is a program that will convert ILBM files into any number of formats. While the full version is not free, the demo version adds a watermark that can be removed.

* Paint Shop Pro 7.04 and other older versions of PSP can read and write ILBM, but can only read PBM files. PSP7 gets a special mention as the shareware version has a bug that allows the evaluation shutdown mechanism to be skipped by simply opening a file (ie. modify shortcut to always open a file and you won't be bothered).

* [https://github.com/steffest/DPaint-js DPaint.js] is a new javascript image editor with a strong focus on Amiga formats. Modelled after the original DeluxePaint. It can be hosted locally, or there is an [https://www.stef.be/dpaint/ online version] available

* [[FuryUtils]] is a suite of tools including ImmFile which can convert some LBM files to and from windows Bmp files. Sufficient to support [[Fury of the Furries]]

== Notes ==

In the [[Commander Keen Dreams]] series of games, compressed standalone ILBM images are used for title screens, but the game does not read most of the ILBM chunks. This is becuase the images were edited in DeluxePaint, then imported directly into the game's files.

== Links ==

[https://web.archive.org/web/20190829195455/https://wiki.multimedia.cx/index.php/IFF IFF]

[https://web.archive.org/web/20070911223155/http://www.szonye.com/bradd/iff.html “EA IFF 85” Standard for Interchange Format Files]

FuryUtils

2023-06-30T13:58:49Z

Carbon14: Update capabilities of the toolset

{{Tool Infobox
| Platform = Windows, Linux
| Release = 2023-04-28 
| Download = [https://github.com/david-c14/FuryStudio/releases/ Releases]
| Edit1 = Extraction
| Edit2 = Format Conversion
| Games =
{{Game|Fury of the Furries}}
}}

'''FuryUtils''' is a suite of tools for modding [[Fury of the Furries]]

* '''DatFile''' is a command line tool for packing and unpacking [[DAT Format (Fury of the Furries)|DAT Format]] archive files.

* '''ImmFile''' is a command line tool for converting [[LBM Format]] and [[IMM Format (Fury of the Furries)|IMM Format]] images files to and from Windows BMP format files.

* There is also a library suitable for C, C++ or C#, containing the same functionality, if you want to build these formats into your own tools.

== Documentation ==

The Utils zip or tar-gz package contains a suite of command line utilities and documentation in markdown format (readable as text). (Windows and Linux)

The Lib zip or tar-gz package contains the core libraries with APIs for C or C++ and a .NET assembly wrapper, along with documentation and code samples. (Windows and Linux)

== Status ==

The suite is currently under active development, and more tools are anticipated.