ModdingWiki - User contributions [en-gb]

OPL chip

2019-07-27T07:40:24Z

ValleyBell: /*B0-B8: Key On / Block Number / F-Number(hi bits)*/ Changing the frequency works on notes with long release rates. (That caused me trouble when trimming/looping VGMs of DOS Lemmings.)

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

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

This manual can be distributed freely if not modified.

=== Disclaimer ===

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

== Introduction ==

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

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

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

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

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

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

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

== Description of the Synthesizer ==

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

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

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

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

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

Well, flaming apart, back to the main topic.

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

=== Two-operator Additive Synthesis ===

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

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

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

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

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

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

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

<pre>
a) FM-FM Mode

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

b) AM-FM Mode

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

c) FM-AM Mode

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

d) AM-AM Mode

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

Nice, aren't they?

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

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

=== Percussion Mode ===

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

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

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

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

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

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

== Programming the Synthesizer ==

OPL3 may be found at the following addresses:

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

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

The chip occupies four I/O addresses:

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

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

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

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

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

== Register Map ==

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

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

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

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

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

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

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

:<nowiki>*</nowiki> This applies only to port base+1
:<nowiki>**</nowiki> This applies only to port base+3

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

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

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

1. Two-operator Melodic Mode

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

2. Two-operator Melodic and Percussion Mode

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

3. Four-operator Melodic Mode

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

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

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

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

4. Four-operator Melodic and Percussion Mode

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

Examples:

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

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

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

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

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

== OPL3 Register Reference ==

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

=== Status Register ===

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

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

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

=== Data Registers ===

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The following table illustrates the effect of different block numbers.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

* NOTE: Bit 5 of register 01 must be set to use waveforms other than sine. Waveforms 4-7 are available only on OPL3. See files WAVEn.GIF for real waveforms, where n is a number between 0 and 7.

== Examples ==

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

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

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

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

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

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

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

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

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

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

== Detection Methods ==

An official method of Adlib (OPL2) detection is:

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

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

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

# Detect OPL2. If present, continue.
# Read status register: read port base+0.
# AND the result with 06h.
# If the result is zero, you have OPL3, otherwise OPL2.

* NOTE: This is NOT an official method. I have dug it out of a sound driver. I haven't tested it, because I haven't an OPL2 card (Adlib, SB Pro I). Nevertheless it "detects" my SB Pro II properly. ;-)

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

== BLASTER Environment Variable ==

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

The variable has this format:

BLASTER=Aaddr Iirq Ddma Ttype

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

Example:

BLASTER=A220 I7 D1 T4

== References ==

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

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

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

OPL chip

2019-07-27T07:32:22Z

ValleyBell: /*Percussion Mode*/ fix notes for percussion mode, based on MAME emulation (I once verified that panning works exactly like this on my SB16.)

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

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

This manual can be distributed freely if not modified.

=== Disclaimer ===

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

== Introduction ==

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

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

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

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

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

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

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

== Description of the Synthesizer ==

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

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

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

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

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

Well, flaming apart, back to the main topic.

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

=== Two-operator Additive Synthesis ===

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

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

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

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

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

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

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

<pre>
a) FM-FM Mode

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

b) AM-FM Mode

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

c) FM-AM Mode

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

d) AM-AM Mode

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

Nice, aren't they?

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

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

=== Percussion Mode ===

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

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

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

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

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

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

== Programming the Synthesizer ==

OPL3 may be found at the following addresses:

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

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

The chip occupies four I/O addresses:

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

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

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

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

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

== Register Map ==

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

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

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

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

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

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

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

:<nowiki>*</nowiki> This applies only to port base+1
:<nowiki>**</nowiki> This applies only to port base+3

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

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

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

1. Two-operator Melodic Mode

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

2. Two-operator Melodic and Percussion Mode

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

3. Four-operator Melodic Mode

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

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

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

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

4. Four-operator Melodic and Percussion Mode

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

Examples:

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

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

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

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

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

== OPL3 Register Reference ==

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

=== Status Register ===

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

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

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

=== Data Registers ===

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The following table illustrates the effect of different block numbers.

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

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

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

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

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

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

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

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

Setting the frequency and/or block while the ''note on'' bit is set will result in the frequency changing immediately. By changing the values gradually, pitch bends can be achieved.

{{TODO|Does changing the frequency just after a note-off cause a pitch bend for those instruments with lengthy release rates?}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

* NOTE: Bit 5 of register 01 must be set to use waveforms other than sine. Waveforms 4-7 are available only on OPL3. See files WAVEn.GIF for real waveforms, where n is a number between 0 and 7.

== Examples ==

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

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

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

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

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

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

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

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

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

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

== Detection Methods ==

An official method of Adlib (OPL2) detection is:

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

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

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

# Detect OPL2. If present, continue.
# Read status register: read port base+0.
# AND the result with 06h.
# If the result is zero, you have OPL3, otherwise OPL2.

* NOTE: This is NOT an official method. I have dug it out of a sound driver. I haven't tested it, because I haven't an OPL2 card (Adlib, SB Pro I). Nevertheless it "detects" my SB Pro II properly. ;-)

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

== BLASTER Environment Variable ==

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

The variable has this format:

BLASTER=Aaddr Iirq Ddma Ttype

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

Example:

BLASTER=A220 I7 D1 T4

== References ==

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

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

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

SoftMax Resource File Format

2016-03-05T12:09:17Z

ValleyBell: fix copy-paste errors

{{Archive Infobox
| MaxFiles = Set by FAT length
| FAT = External
| Names = N
| Metadata = None
| Subdirectories = N
| Compressed = N
| Encrypted = N
| Hidden = N
| Games =
{{Game|Sky & Rica}}
}}
The '''SoftMax Resource File Format''' is used by games of the Korean developer Softmax.
The format itself stores no offsets and/or file names. Instead, potential file tables are stored in the game EXE files or are even calculated using formulas.

The format is very similar to [[ArtCraft Resource File Format]], which is used in the earlier released game [[Lychnis]].

== File format ==

=== Signature ===

Sky & Rica uses the following signature:
{|class="wikitable"
! Data type!!Name!!Description
|-
|BYTE[0x20]||cSignature||"(C) SoftMax Resource File" 0x1A 0x00*6
|}

=== FAT ===
The File Allocation Table, if available, is stored in the game executables.

[[Sky & Rica]] (unlike Lychnis) stores only very few information about the resource files. For most of the files, there is only a list of UINT32LE file offsets. For the sound effects, there is an additional UINT32LE list of file sizes. For some files, offsets are calculated by the game.
S&R.EXE and SETUP.EXE don't use resource files.

{|class="wikitable"
!EXE File!!Resource file!!Number of files!!File offsets!!File sizes!!File type
|-
|rowspan="5"|FRAME.EXE ||s&r4.res||135*||0x011A84|| -- ||Sprites
|-
| s&r1.res|| 10*||0x01242C|| -- ||Cutscene Data?
|-
| s&r2.res|| 10*||0x012454|| -- ||Cutscene Data?
|-
| s&r5.res|| 44*||0x012700|| -- ||Music
|-
| s&r5.res|| 33 ||0x012806||0x01288A||Sound Effects
|-
|rowspan="3"|STAGE1.EXE||s&r4.res||120 ||0x012F9C|| -- ||Sprites
|-
| s&r5.res|| 42 ||0x013DAA|| -- ||Music
|-
| s&r5.res|| 34*||0x013EA8||0x013F34||Sound Effects
|-
|rowspan="3"|STAGE2.EXE||s&r4.res||132 ||0x01305C|| -- ||Sprites
|-
| s&r5.res|| 34 ||0x013E6A|| -- ||Music
|-
| s&r5.res|| 34*||0x013FBC||0x014048||Sound Effects
|-
|rowspan="3"|STAGE3.EXE||s&r4.res||120 ||0x012224|| -- ||Sprites
|-
| s&r5.res|| 42 ||0x013028|| -- ||Music
|-
| s&r5.res|| 34*||0x013126||0x0131B2||Sound Effects
|-
|rowspan="3"|STAGE4.EXE||s&r4.res||120 ||0x013994|| -- ||Sprites
|-
| s&r5.res|| 34 ||0x0147D2|| -- ||Music
|-
| s&r5.res|| 34*||0x014924||0x0149B0||Sound Effects
|-
|rowspan="3"|STAGE5.EXE||s&r4.res||133 ||0x0138C4|| -- ||Sprites
|-
| s&r5.res|| 34 ||0x0146D8|| -- ||Music
|-
| s&r5.res|| 34*||0x01482A||0x0148B6||Sound Effects
|-
|rowspan="3"|STAGE6.EXE||s&r4.res||120 ||0x0121B4|| -- ||Sprites
|-
| s&r5.res|| 44*||0x012FCC|| -- ||Music
|-
| s&r5.res|| 34*||0x0130CA||0x013156||Sound Effects
|-
|rowspan="3"|STAGE7.EXE||s&r4.res||120 ||0x013754|| -- ||Sprites
|-
| s&r5.res|| 34 ||0x014558|| -- ||Music
|-
| s&r5.res|| 34*||0x0146AA||0x014736||Sound Effects
|-
|rowspan="3"|STAGE9.EXE||s&r4.res||134 ||0x011CE4|| -- ||Sprites
|-
| s&r5.res|| 34 ||0x012AFA|| -- ||Music
|-
| s&r5.res|| 34*||0x012C4C||0x012CD8||Sound Effects
|-
|rowspan="3"|TITLE.EXE ||s&r4.res||120 ||0x0088A6|| -- ||Sprites
|-
| s&r5.res|| 34 ||0x008F2A|| -- ||Music
|-
| s&r5.res|| 34*||0x00907C||0x009108||Sound Effects
|}
It should be noted that not all executables have full file tables. For example, <tt>TITLE.EXE</tt> doesn't have all music offsets, but the SFX list is complete. <tt>FRAME.EXE</tt> has all music offsets, but lacks one sound effect.
All complete tables are marked with a *.

Sound Effects are raw 8-bit unsigned PCM. Music consists of IMS and BNK files.

== List of files ==

The following table lists the contents of <tt>S&R1.RES</tt>.
{|class="wikitable"
!File #!!Offset!!Size!!Format!!Notes
|-
|0||0x000020||887935||unknown||
|-
|1||0x0D8C9F||333482||unknown||
|-
|2||0x12A349||27524||unknown||
|-
|3||0x130ECD||22472||unknown||
|-
|4||0x136695||402640||unknown||
|-
|5||0x198B65||137224||unknown||
|-
|6||0x1BA36D||296062||unknown||
|-
|7||0x2027EB||126749||unknown||
|-
|8||0x221708||183262||unknown||
|-
|9||0x24E2E6||143358||unknown||
|}

The following table lists the contents of <tt>S&R2.RES</tt>.
{|class="wikitable"
!File #!!Offset!!Size!!Format!!Notes
|-
|0||0x000020||204805||unknown||
|-
|1||0x032025||665605||unknown||
|-
|2||0x0D482A||65413||unknown||
|-
|3||0x0E47AF||422061||unknown||
|-
|4||0x14B85C||363058||unknown||
|-
|5||0x1A428E||237377||unknown||
|-
|6||0x1DE1CF||446701||unknown||
|-
|7||0x24B2BC||447507||unknown||
|-
|8||0x2B86CF||66560||unknown||
|-
|9||0x2C8ACF||189980||unknown||
|}

The following table lists the contents of <tt>S&R3.RES</tt>.
{|class="wikitable"
!File #!!Offset!!Size!!Format!!Notes
|-
|0||0x000020||6752||Map Data||Title Screen
|-
|1||0x001A80||16128||Map Data||Stage 1
|-
|2||0x005980||16128||Map Data||Stage 2
|-
|3||0x009880||14528||Map Data||Stage 3
|-
|4||0x00D140||16128||Map Data||Stage 4
|-
|5||0x011040||16128||Map Data||Stage 5
|-
|6||0x014F40||16128||Map Data||Stage 6
|-
|7||0x018E40||14368||Map Data||Stage 7
|-
|8||0x01C660||75904||Tile Data||Title Screen
|-
|9||0x02EEE0||216192||Tile Data||Stage 1
|-
|10||0x063B60||252032||Tile Data||Stage 2
|-
|11||0x0A13E0||400768||Tile Data||Stage 3
|-
|12||0x103160||232064||Tile Data||Stage 4
|-
|13||0x13BBE0||173440||Tile Data||Stage 5
|-
|14||0x166160||236928||Tile Data||Stage 6
|-
|15||0x19FEE0||330368||Tile Data||Stage 7
|-
|16||0x1F0960||16896||Map Data||Stage 9
|-
|17||0x1F4B60||252032||Tile Data||Stage 9
|}
Since all of the offsets are hardcoded into the game executables, I searched for magic bytes.
Those were "Map File" and "Tile File" for map and tile data respectively. Both file types also contain the string "Innovation! 1994".
In the <tt>STAGE#.EXE</tt> files the offsets can be located by searching for the following magic bytes: 
Map Data (4-byte offset): <tt>F8 89 46 F6 6A 00 66 68 xx xx xx xx</tt> 
Map Data (1-byte offset): <tt>F8 89 46 F6 6A 00 66 6A xx</tt> 
Tile Data (4-byte offset): <tt>FA 89 46 F8 6A 00 66 68 xx xx xx xx</tt>

The following table lists the contents of <tt>S&R4.RES</tt>.
{|class="wikitable"
!File #!!Offset!!Size!!Format!!Notes
|-
|0||0x000020||11367||Sprite Data||
|-
|1||0x002C87||9268||Sprite Data||
|-
|2||0x0050BB||34823||Sprite Data||
|-
|3||0x00D8C2||25280||Sprite Data||
|-
|4||0x013B82||7640||Sprite Data||
|-
|5||0x01595A||14302||Sprite Data||
|-
|6||0x019138||28980||Sprite Data||
|-
|7||0x02026C||14448||Sprite Data||
|-
|8||0x023ADC||4435||Sprite Data||
|-
|9||0x024C2F||13515||Sprite Data||
|-
|10||0x0280FA||10548||Sprite Data||
|-
|11||0x02AA2E||13956||Sprite Data||
|-
|12||0x02E0B2||5752||Sprite Data||
|-
|13||0x02F72A||10245||Sprite Data||
|-
|14||0x031F2F||3846||Sprite Data||
|-
|15||0x032E35||16144||Sprite Data||
|-
|16||0x036D45||11848||Sprite Data||
|-
|17||0x039B8D||7194||Sprite Data||
|-
|18||0x03B7A7||8642||Sprite Data||
|-
|19||0x03D969||13390||Sprite Data||
|-
|20||0x040DB7||12972||Sprite Data||
|-
|21||0x044063||6822||Sprite Data||
|-
|22||0x045B09||7216||Sprite Data||
|-
|23||0x047739||15168||Sprite Data||
|-
|24||0x04B279||40454||Sprite Data||
|-
|25||0x05507F||10136||Sprite Data||
|-
|26||0x057817||7347||Sprite Data||
|-
|27||0x0594CA||7566||Sprite Data||
|-
|28||0x05B258||5436||Sprite Data||
|-
|29||0x05C794||8796||Sprite Data||
|-
|30||0x05E9F0||9283||Sprite Data||
|-
|31||0x060E33||3717||Sprite Data||
|-
|32||0x061CB8||11706||Sprite Data||
|-
|33||0x064A72||13298||Sprite Data||
|-
|34||0x067E64||11108||Sprite Data||
|-
|35||0x06A9C8||3417||Sprite Data||
|-
|36||0x06B721||39070||Sprite Data||
|-
|37||0x074FBF||5588||Sprite Data||
|-
|38||0x076593||8923||Sprite Data||
|-
|39||0x07886E||5450||Sprite Data||
|-
|40||0x079DB8||11653||Sprite Data||
|-
|41||0x07CB3D||53464||Sprite Data||
|-
|42||0x089C15||11620||Sprite Data||
|-
|43||0x08C979||6494||Sprite Data||
|-
|44||0x08E2D7||3146||Sprite Data||
|-
|45||0x08EF21||20656||Sprite Data||
|-
|46||0x093FD1||1922||Sprite Data||
|-
|47||0x094753||17723||Sprite Data||
|-
|48||0x098C8E||8592||Sprite Data||
|-
|49||0x09AE1E||5013||Sprite Data||
|-
|50||0x09C1B3||34029||Sprite Data||
|-
|51||0x0A46A0||26605||Sprite Data||
|-
|52||0x0AAE8D||4276||Sprite Data||
|-
|53||0x0ABF41||35885||Sprite Data||
|-
|54||0x0B4B6E||47021||Sprite Data||
|-
|55||0x0C031B||7005||Sprite Data||
|-
|56||0x0C1E78||26605||Sprite Data||
|-
|57||0x0C8665||26605||Sprite Data||
|-
|58||0x0CEE52||34029||Sprite Data||
|-
|59||0x0D733F||1958||Sprite Data||
|-
|60||0x0D7AE5||3584||Sprite Data||
|-
|61||0x0D88E5||2789||Sprite Data||
|-
|62||0x0D93CA||7121||Sprite Data||
|-
|63||0x0DAF9B||13715||Sprite Data||
|-
|64||0x0DE52E||21591||Sprite Data||
|-
|65||0x0E3985||9948||Sprite Data||
|-
|66||0x0E6061||7054||Sprite Data||
|-
|67||0x0E7BEF||4680||Sprite Data||
|-
|68||0x0E8E37||3378||Sprite Data||
|-
|69||0x0E9B69||5103||Sprite Data||
|-
|70||0x0EAF58||6835||Sprite Data||
|-
|71||0x0ECA0B||9360||Sprite Data||
|-
|72||0x0EEE9B||172253||Sprite Data||
|-
|73||0x118F78||147305||Sprite Data||
|-
|74||0x13CEE1||19053||Sprite Data||
|-
|75||0x14194E||1787||Sprite Data||
|-
|76||0x142049||1513||Sprite Data||
|-
|77||0x142632||4962||Sprite Data||
|-
|78||0x143994||10437||Sprite Data||
|-
|79||0x146259||6622||Sprite Data||
|-
|80||0x147C37||3464||Sprite Data||
|-
|81||0x1489BF||4085||Sprite Data||
|-
|82||0x1499B4||27629||Sprite Data||
|-
|83||0x1505A1||19785||Sprite Data||
|-
|84||0x1552EA||4164||Sprite Data||
|-
|85||0x15632E||17084||Sprite Data||
|-
|86||0x15A5EA||13467||Sprite Data||
|-
|87||0x15DA85||7184||Sprite Data||
|-
|88||0x15F695||44831||Sprite Data||
|-
|89||0x16A5B4||8968||Sprite Data||
|-
|90||0x16C8BC||63467||Sprite Data||
|-
|91||0x17C0A7||8856||Sprite Data||
|-
|92||0x17E33F||6715||Sprite Data||
|-
|93||0x17FD7A||4050||Sprite Data||
|-
|94||0x180D4C||1355||Sprite Data||
|-
|95||0x181297||12398||Sprite Data||
|-
|96||0x184305||16593||Sprite Data||
|-
|97||0x1883D6||108061||Sprite Data||
|-
|98||0x1A29F3||3604||Sprite Data||
|-
|99||0x1A3807||33899||Sprite Data||
|-
|100||0x1ABC72||16701||Sprite Data||
|-
|101||0x1AFDAF||63112||Sprite Data||
|-
|102||0x1BF437||9400||Sprite Data||
|-
|103||0x1C18EF||4269||Sprite Data||
|-
|104||0x1C299C||6613||Sprite Data||
|-
|105||0x1C4371||44437||Sprite Data||
|-
|106||0x1CF106||3259||Sprite Data||
|-
|107||0x1CFDC1||7243||Sprite Data||
|-
|108||0x1D1A0C||11166||Sprite Data||
|-
|109||0x1D45AA||48331||Sprite Data||
|-
|110||0x1E0275||3010||Sprite Data||
|-
|111||0x1E0E37||83755||Sprite Data||
|-
|112||0x1F5562||10248||Sprite Data||
|-
|113||0x1F7D6A||3729||Sprite Data||
|-
|114||0x1F8BFB||7018||Sprite Data||
|-
|115||0x1FA765||14275||Sprite Data||
|-
|116||0x1FDF28||3192||Sprite Data||
|-
|117||0x1FEBA0||8064||Sprite Data||
|-
|118||0x200B20||7931||Sprite Data||
|-
|119||0x202A1B||6108||Sprite Data||
|-
|120||0x2041F7||18091||Sprite Data||
|-
|121||0x2088A2||118034||Sprite Data||
|-
|122||0x2255B4||31292||Sprite Data||
|-
|123||0x22CFF0||1484||Sprite Data||
|-
|124||0x22D5BC||4637||Sprite Data||
|-
|125||0x22E7D9||7771||Sprite Data||
|-
|126||0x230634||3980||Sprite Data||
|-
|127||0x2315C0||27329||Sprite Data||
|-
|128||0x238081||11086||Sprite Data||
|-
|129||0x23ABCF||4631||Sprite Data||
|-
|130||0x23BDE6||1417||Sprite Data||
|-
|131||0x23C36F||16593||Sprite Data||
|-
|132||0x240440||33899||Sprite Data||
|-
|133||0x2488AB||39938||Sprite Data||
|-
|134||0x2524AD||8222||Sprite Data||
|}

The following table lists the contents of <tt>S&R5.RES</tt>.
{|class="wikitable"
!File #!!Offset!!Size!!Format!!Notes
|-
|0||0x000020||4609||PCM Sound Effect||
|-
|1||0x001221||4609||PCM Sound Effect||
|-
|2||0x002422||7759||PCM Sound Effect||
|-
|3||0x004271||7759||PCM Sound Effect||
|-
|4||0x0060C0||3735||PCM Sound Effect||
|-
|5||0x006F57||11387||PCM Sound Effect||
|-
|6||0x009BD2||6244||PCM Sound Effect||
|-
|7||0x00B436||12243||PCM Sound Effect||
|-
|8||0x00E409||7532||PCM Sound Effect||
|-
|9||0x010175||14259||PCM Sound Effect||
|-
|10||0x013928||6203||PCM Sound Effect||
|-
|11||0x015163||19699||PCM Sound Effect||
|-
|12||0x019E56||42261||PCM Sound Effect||
|-
|13||0x02436B||6169||PCM Sound Effect||
|-
|14||0x025B84||4318||PCM Sound Effect||
|-
|15||0x026C62||3702||PCM Sound Effect||
|-
|16||0x027AD8||7944||PCM Sound Effect||
|-
|17||0x0299E0||2167||PCM Sound Effect||
|-
|18||0x02A257||3006||PCM Sound Effect||
|-
|19||0x02AE15||4667||PCM Sound Effect||
|-
|20||0x02C050||7901||PCM Sound Effect||
|-
|21||0x02DF2D||5982||PCM Sound Effect||
|-
|22||0x02F68B||9396||PCM Sound Effect||
|-
|23||0x031B3F||156577||PCM Sound Effect||
|-
|24||0x057EE0||2715||PCM Sound Effect||
|-
|25||0x05897B||2608||PCM Sound Effect||
|-
|26||0x0593AB||3480||PCM Sound Effect||
|-
|27||0x05A143||6480||PCM Sound Effect||
|-
|28||0x05BA93||9771||PCM Sound Effect||
|-
|29||0x05E0BE||2284||PCM Sound Effect||
|-
|30||0x05E9AA||1435||PCM Sound Effect||
|-
|31||0x05EF45||39331||PCM Sound Effect||
|-
|32||0x0688E8||2177||PCM Sound Effect||
|-
|33||0x069169||12701||PCM Sound Effect||
|-
|34||0x06C306||1372||[[AdLib Instrument Bank Format]]||
|-
|35||0x06C862||1372||[[AdLib Instrument Bank Format]]||
|-
|36||0x06CDBE||1372||[[AdLib Instrument Bank Format]]||
|-
|37||0x06D31A||1372||[[AdLib Instrument Bank Format]]||
|-
|38||0x06D876||1372||[[AdLib Instrument Bank Format]]||
|-
|39||0x06DDD2||1372||[[AdLib Instrument Bank Format]]||
|-
|40||0x06E32E||1372||[[AdLib Instrument Bank Format]]||
|-
|41||0x06E88A||1372||[[AdLib Instrument Bank Format]]||
|-
|42||0x06EDE6||1372||[[AdLib Instrument Bank Format]]||
|-
|43||0x06F342||1372||[[AdLib Instrument Bank Format]]||
|-
|44||0x06F89E||1372||[[AdLib Instrument Bank Format]]||
|-
|45||0x06FDFA||1372||[[AdLib Instrument Bank Format]]||
|-
|46||0x070356||1372||[[AdLib Instrument Bank Format]]||
|-
|47||0x0708B2||1372||[[AdLib Instrument Bank Format]]||
|-
|48||0x070E0E||1372||[[AdLib Instrument Bank Format]]||
|-
|49||0x07136A||1372||[[AdLib Instrument Bank Format]]||
|-
|50||0x0718C6||1372||[[AdLib Instrument Bank Format]]||
|-
|51||0x071E22||14491||[[IMS Format]]||
|-
|52||0x0756BD||2179||[[IMS Format]]||
|-
|53||0x075F40||2416||[[IMS Format]]||
|-
|54||0x0768B0||438||[[IMS Format]]||
|-
|55||0x076A66||2836||[[IMS Format]]||
|-
|56||0x07757A||9280||[[IMS Format]]||
|-
|57||0x0799BA||4833||[[IMS Format]]||
|-
|58||0x07AC9B||4013||[[IMS Format]]||
|-
|59||0x07BC48||651||[[IMS Format]]||
|-
|60||0x07BED3||9877||[[IMS Format]]||
|-
|61||0x07E568||5364||[[IMS Format]]||
|-
|62||0x07FA5C||6790||[[IMS Format]]||
|-
|63||0x0814E2||8586||[[IMS Format]]||
|-
|64||0x08366C||7699||[[IMS Format]]||
|-
|65||0x08547F||15395||[[IMS Format]]||
|-
|66||0x0890A2||9218||[[IMS Format]]||
|-
|67||0x08B4A4||2843||[[IMS Format]]||
|-
|68||0x08BFBF||6790||[[IMS Format]]||
|-
|69||0x08DA45||15386||[[IMS Format]]||
|-
|70||0x09165F||3413||[[IMS Format]]||
|-
|71||0x0923B4||9087||[[IMS Format]]||
|-
|72||0x094733||7158||[[IMS Format]]||
|-
|73||0x096329||1372||[[AdLib Instrument Bank Format]]||
|-
|74||0x096885||1372||[[AdLib Instrument Bank Format]]||
|-
|75||0x096DE1||1372||[[AdLib Instrument Bank Format]]||
|-
|76||0x09733D||4837||[[IMS Format]]||
|-
|77||0x098622||1372||[[AdLib Instrument Bank Format]]||
|-
|78||0x098B7E||210650||unknown||
|}
PCM Sound Effects are raw 8-bit unsigned, but end with a 00 byte like [[VOC Format|VOC Files]].
There is one Instrument Bank (BNK) file for each IMS song. The first BNK belongs to the first IMS, the second BNK to the second IMS, etc.

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

SoftMax Resource File Format

2016-03-05T12:04:14Z

ValleyBell: instrument banks are BNK Format

{{Archive Infobox
| MaxFiles = Set by FAT length
| FAT = External
| Names = N
| Metadata = None
| Subdirectories = N
| Compressed = N
| Encrypted = N
| Hidden = N
| Games =
{{Game|Sky & Rica}}
}}
The '''ArtCraft Resource File Format''' is used by games of the Korean developer Artcraft.
The format itself stores no offsets and/or file names. Instead, potential file tables are stored in the game EXE files or are even calculated using formulas.

The format is very similar to [[ArtCraft Resource File Format]], which is used in the earlier released game [[Lychnis]].

== File format ==

=== Signature ===

Sky & Rica uses the following signature:
{|class="wikitable"
! Data type!!Name!!Description
|-
|BYTE[0x20]||cSignature||"(C) SoftMax Resource File" 0x1A 0x00*6
|}

=== FAT ===
The File Allocation Table, if available, is stored in the game executables.

[[Sky & Rica]] (unlike Lychnis) stores only very few information about the resource files. For most of the files, there is only a list of UINT32LE file offsets. For the sound effects, there is an additional UINT32LE list of file sizes. For some files, offsets are calculated by the game.
S&R.EXE and SETUP.EXE don't use resource files.

{|class="wikitable"
!EXE File!!Resource file!!Number of files!!File offsets!!File sizes!!File type
|-
|rowspan="5"|FRAME.EXE ||s&r4.res||135*||0x011A84|| -- ||Sprites
|-
| s&r1.res|| 10*||0x01242C|| -- ||Cutscene Data?
|-
| s&r2.res|| 10*||0x012454|| -- ||Cutscene Data?
|-
| s&r5.res|| 44*||0x012700|| -- ||Music
|-
| s&r5.res|| 33 ||0x012806||0x01288A||Sound Effects
|-
|rowspan="3"|STAGE1.EXE||s&r4.res||120 ||0x012F9C|| -- ||Sprites
|-
| s&r5.res|| 42 ||0x013DAA|| -- ||Music
|-
| s&r5.res|| 34*||0x013EA8||0x013F34||Sound Effects
|-
|rowspan="3"|STAGE2.EXE||s&r4.res||132 ||0x01305C|| -- ||Sprites
|-
| s&r5.res|| 34 ||0x013E6A|| -- ||Music
|-
| s&r5.res|| 34*||0x013FBC||0x014048||Sound Effects
|-
|rowspan="3"|STAGE3.EXE||s&r4.res||120 ||0x012224|| -- ||Sprites
|-
| s&r5.res|| 42 ||0x013028|| -- ||Music
|-
| s&r5.res|| 34*||0x013126||0x0131B2||Sound Effects
|-
|rowspan="3"|STAGE4.EXE||s&r4.res||120 ||0x013994|| -- ||Sprites
|-
| s&r5.res|| 34 ||0x0147D2|| -- ||Music
|-
| s&r5.res|| 34*||0x014924||0x0149B0||Sound Effects
|-
|rowspan="3"|STAGE5.EXE||s&r4.res||133 ||0x0138C4|| -- ||Sprites
|-
| s&r5.res|| 34 ||0x0146D8|| -- ||Music
|-
| s&r5.res|| 34*||0x01482A||0x0148B6||Sound Effects
|-
|rowspan="3"|STAGE6.EXE||s&r4.res||120 ||0x0121B4|| -- ||Sprites
|-
| s&r5.res|| 44*||0x012FCC|| -- ||Music
|-
| s&r5.res|| 34*||0x0130CA||0x013156||Sound Effects
|-
|rowspan="3"|STAGE7.EXE||s&r4.res||120 ||0x013754|| -- ||Sprites
|-
| s&r5.res|| 34 ||0x014558|| -- ||Music
|-
| s&r5.res|| 34*||0x0146AA||0x014736||Sound Effects
|-
|rowspan="3"|STAGE9.EXE||s&r4.res||134 ||0x011CE4|| -- ||Sprites
|-
| s&r5.res|| 34 ||0x012AFA|| -- ||Music
|-
| s&r5.res|| 34*||0x012C4C||0x012CD8||Sound Effects
|-
|rowspan="3"|TITLE.EXE ||s&r4.res||120 ||0x0088A6|| -- ||Sprites
|-
| s&r5.res|| 34 ||0x008F2A|| -- ||Music
|-
| s&r5.res|| 34*||0x00907C||0x009108||Sound Effects
|}
It should be noted that not all executables have full file tables. For example, <tt>TITLE.EXE</tt> doesn't have all music offsets, but the SFX list is complete. <tt>FRAME.EXE</tt> has all music offsets, but lacks one sound effect.
All complete tables are marked with a *.

Sound Effects are raw 8-bit unsigned PCM. Music consists of IMS and BNK files.

== List of files ==

The following table lists the contents of <tt>S&R1.RES</tt>.
{|class="wikitable"
!File #!!Offset!!Size!!Format!!Notes
|-
|0||0x000020||887935||unknown||
|-
|1||0x0D8C9F||333482||unknown||
|-
|2||0x12A349||27524||unknown||
|-
|3||0x130ECD||22472||unknown||
|-
|4||0x136695||402640||unknown||
|-
|5||0x198B65||137224||unknown||
|-
|6||0x1BA36D||296062||unknown||
|-
|7||0x2027EB||126749||unknown||
|-
|8||0x221708||183262||unknown||
|-
|9||0x24E2E6||143358||unknown||
|}

The following table lists the contents of <tt>S&R2.RES</tt>.
{|class="wikitable"
!File #!!Offset!!Size!!Format!!Notes
|-
|0||0x000020||204805||unknown||
|-
|1||0x032025||665605||unknown||
|-
|2||0x0D482A||65413||unknown||
|-
|3||0x0E47AF||422061||unknown||
|-
|4||0x14B85C||363058||unknown||
|-
|5||0x1A428E||237377||unknown||
|-
|6||0x1DE1CF||446701||unknown||
|-
|7||0x24B2BC||447507||unknown||
|-
|8||0x2B86CF||66560||unknown||
|-
|9||0x2C8ACF||189980||unknown||
|}

The following table lists the contents of <tt>S&R3.RES</tt>.
{|class="wikitable"
!File #!!Offset!!Size!!Format!!Notes
|-
|0||0x000020||6752||Map Data||Title Screen
|-
|1||0x001A80||16128||Map Data||Stage 1
|-
|2||0x005980||16128||Map Data||Stage 2
|-
|3||0x009880||14528||Map Data||Stage 3
|-
|4||0x00D140||16128||Map Data||Stage 4
|-
|5||0x011040||16128||Map Data||Stage 5
|-
|6||0x014F40||16128||Map Data||Stage 6
|-
|7||0x018E40||14368||Map Data||Stage 7
|-
|8||0x01C660||75904||Tile Data||Title Screen
|-
|9||0x02EEE0||216192||Tile Data||Stage 1
|-
|10||0x063B60||252032||Tile Data||Stage 2
|-
|11||0x0A13E0||400768||Tile Data||Stage 3
|-
|12||0x103160||232064||Tile Data||Stage 4
|-
|13||0x13BBE0||173440||Tile Data||Stage 5
|-
|14||0x166160||236928||Tile Data||Stage 6
|-
|15||0x19FEE0||330368||Tile Data||Stage 7
|-
|16||0x1F0960||16896||Map Data||Stage 9
|-
|17||0x1F4B60||252032||Tile Data||Stage 9
|}
Since all of the offsets are hardcoded into the game executables, I searched for magic bytes.
Those were "Map File" and "Tile File" for map and tile data respectively. Both file types also contain the string "Innovation! 1994".
In the <tt>STAGE#.EXE</tt> files the offsets can be located by searching for the following magic bytes: 
Map Data (4-byte offset): <tt>F8 89 46 F6 6A 00 66 68 xx xx xx xx</tt> 
Map Data (1-byte offset): <tt>F8 89 46 F6 6A 00 66 6A xx</tt> 
Tile Data (4-byte offset): <tt>FA 89 46 F8 6A 00 66 68 xx xx xx xx</tt>

The following table lists the contents of <tt>S&R4.RES</tt>.
{|class="wikitable"
!File #!!Offset!!Size!!Format!!Notes
|-
|0||0x000020||11367||Sprite Data||
|-
|1||0x002C87||9268||Sprite Data||
|-
|2||0x0050BB||34823||Sprite Data||
|-
|3||0x00D8C2||25280||Sprite Data||
|-
|4||0x013B82||7640||Sprite Data||
|-
|5||0x01595A||14302||Sprite Data||
|-
|6||0x019138||28980||Sprite Data||
|-
|7||0x02026C||14448||Sprite Data||
|-
|8||0x023ADC||4435||Sprite Data||
|-
|9||0x024C2F||13515||Sprite Data||
|-
|10||0x0280FA||10548||Sprite Data||
|-
|11||0x02AA2E||13956||Sprite Data||
|-
|12||0x02E0B2||5752||Sprite Data||
|-
|13||0x02F72A||10245||Sprite Data||
|-
|14||0x031F2F||3846||Sprite Data||
|-
|15||0x032E35||16144||Sprite Data||
|-
|16||0x036D45||11848||Sprite Data||
|-
|17||0x039B8D||7194||Sprite Data||
|-
|18||0x03B7A7||8642||Sprite Data||
|-
|19||0x03D969||13390||Sprite Data||
|-
|20||0x040DB7||12972||Sprite Data||
|-
|21||0x044063||6822||Sprite Data||
|-
|22||0x045B09||7216||Sprite Data||
|-
|23||0x047739||15168||Sprite Data||
|-
|24||0x04B279||40454||Sprite Data||
|-
|25||0x05507F||10136||Sprite Data||
|-
|26||0x057817||7347||Sprite Data||
|-
|27||0x0594CA||7566||Sprite Data||
|-
|28||0x05B258||5436||Sprite Data||
|-
|29||0x05C794||8796||Sprite Data||
|-
|30||0x05E9F0||9283||Sprite Data||
|-
|31||0x060E33||3717||Sprite Data||
|-
|32||0x061CB8||11706||Sprite Data||
|-
|33||0x064A72||13298||Sprite Data||
|-
|34||0x067E64||11108||Sprite Data||
|-
|35||0x06A9C8||3417||Sprite Data||
|-
|36||0x06B721||39070||Sprite Data||
|-
|37||0x074FBF||5588||Sprite Data||
|-
|38||0x076593||8923||Sprite Data||
|-
|39||0x07886E||5450||Sprite Data||
|-
|40||0x079DB8||11653||Sprite Data||
|-
|41||0x07CB3D||53464||Sprite Data||
|-
|42||0x089C15||11620||Sprite Data||
|-
|43||0x08C979||6494||Sprite Data||
|-
|44||0x08E2D7||3146||Sprite Data||
|-
|45||0x08EF21||20656||Sprite Data||
|-
|46||0x093FD1||1922||Sprite Data||
|-
|47||0x094753||17723||Sprite Data||
|-
|48||0x098C8E||8592||Sprite Data||
|-
|49||0x09AE1E||5013||Sprite Data||
|-
|50||0x09C1B3||34029||Sprite Data||
|-
|51||0x0A46A0||26605||Sprite Data||
|-
|52||0x0AAE8D||4276||Sprite Data||
|-
|53||0x0ABF41||35885||Sprite Data||
|-
|54||0x0B4B6E||47021||Sprite Data||
|-
|55||0x0C031B||7005||Sprite Data||
|-
|56||0x0C1E78||26605||Sprite Data||
|-
|57||0x0C8665||26605||Sprite Data||
|-
|58||0x0CEE52||34029||Sprite Data||
|-
|59||0x0D733F||1958||Sprite Data||
|-
|60||0x0D7AE5||3584||Sprite Data||
|-
|61||0x0D88E5||2789||Sprite Data||
|-
|62||0x0D93CA||7121||Sprite Data||
|-
|63||0x0DAF9B||13715||Sprite Data||
|-
|64||0x0DE52E||21591||Sprite Data||
|-
|65||0x0E3985||9948||Sprite Data||
|-
|66||0x0E6061||7054||Sprite Data||
|-
|67||0x0E7BEF||4680||Sprite Data||
|-
|68||0x0E8E37||3378||Sprite Data||
|-
|69||0x0E9B69||5103||Sprite Data||
|-
|70||0x0EAF58||6835||Sprite Data||
|-
|71||0x0ECA0B||9360||Sprite Data||
|-
|72||0x0EEE9B||172253||Sprite Data||
|-
|73||0x118F78||147305||Sprite Data||
|-
|74||0x13CEE1||19053||Sprite Data||
|-
|75||0x14194E||1787||Sprite Data||
|-
|76||0x142049||1513||Sprite Data||
|-
|77||0x142632||4962||Sprite Data||
|-
|78||0x143994||10437||Sprite Data||
|-
|79||0x146259||6622||Sprite Data||
|-
|80||0x147C37||3464||Sprite Data||
|-
|81||0x1489BF||4085||Sprite Data||
|-
|82||0x1499B4||27629||Sprite Data||
|-
|83||0x1505A1||19785||Sprite Data||
|-
|84||0x1552EA||4164||Sprite Data||
|-
|85||0x15632E||17084||Sprite Data||
|-
|86||0x15A5EA||13467||Sprite Data||
|-
|87||0x15DA85||7184||Sprite Data||
|-
|88||0x15F695||44831||Sprite Data||
|-
|89||0x16A5B4||8968||Sprite Data||
|-
|90||0x16C8BC||63467||Sprite Data||
|-
|91||0x17C0A7||8856||Sprite Data||
|-
|92||0x17E33F||6715||Sprite Data||
|-
|93||0x17FD7A||4050||Sprite Data||
|-
|94||0x180D4C||1355||Sprite Data||
|-
|95||0x181297||12398||Sprite Data||
|-
|96||0x184305||16593||Sprite Data||
|-
|97||0x1883D6||108061||Sprite Data||
|-
|98||0x1A29F3||3604||Sprite Data||
|-
|99||0x1A3807||33899||Sprite Data||
|-
|100||0x1ABC72||16701||Sprite Data||
|-
|101||0x1AFDAF||63112||Sprite Data||
|-
|102||0x1BF437||9400||Sprite Data||
|-
|103||0x1C18EF||4269||Sprite Data||
|-
|104||0x1C299C||6613||Sprite Data||
|-
|105||0x1C4371||44437||Sprite Data||
|-
|106||0x1CF106||3259||Sprite Data||
|-
|107||0x1CFDC1||7243||Sprite Data||
|-
|108||0x1D1A0C||11166||Sprite Data||
|-
|109||0x1D45AA||48331||Sprite Data||
|-
|110||0x1E0275||3010||Sprite Data||
|-
|111||0x1E0E37||83755||Sprite Data||
|-
|112||0x1F5562||10248||Sprite Data||
|-
|113||0x1F7D6A||3729||Sprite Data||
|-
|114||0x1F8BFB||7018||Sprite Data||
|-
|115||0x1FA765||14275||Sprite Data||
|-
|116||0x1FDF28||3192||Sprite Data||
|-
|117||0x1FEBA0||8064||Sprite Data||
|-
|118||0x200B20||7931||Sprite Data||
|-
|119||0x202A1B||6108||Sprite Data||
|-
|120||0x2041F7||18091||Sprite Data||
|-
|121||0x2088A2||118034||Sprite Data||
|-
|122||0x2255B4||31292||Sprite Data||
|-
|123||0x22CFF0||1484||Sprite Data||
|-
|124||0x22D5BC||4637||Sprite Data||
|-
|125||0x22E7D9||7771||Sprite Data||
|-
|126||0x230634||3980||Sprite Data||
|-
|127||0x2315C0||27329||Sprite Data||
|-
|128||0x238081||11086||Sprite Data||
|-
|129||0x23ABCF||4631||Sprite Data||
|-
|130||0x23BDE6||1417||Sprite Data||
|-
|131||0x23C36F||16593||Sprite Data||
|-
|132||0x240440||33899||Sprite Data||
|-
|133||0x2488AB||39938||Sprite Data||
|-
|134||0x2524AD||8222||Sprite Data||
|}

The following table lists the contents of <tt>S&R5.RES</tt>.
{|class="wikitable"
!File #!!Offset!!Size!!Format!!Notes
|-
|0||0x000020||4609||PCM Sound Effect||
|-
|1||0x001221||4609||PCM Sound Effect||
|-
|2||0x002422||7759||PCM Sound Effect||
|-
|3||0x004271||7759||PCM Sound Effect||
|-
|4||0x0060C0||3735||PCM Sound Effect||
|-
|5||0x006F57||11387||PCM Sound Effect||
|-
|6||0x009BD2||6244||PCM Sound Effect||
|-
|7||0x00B436||12243||PCM Sound Effect||
|-
|8||0x00E409||7532||PCM Sound Effect||
|-
|9||0x010175||14259||PCM Sound Effect||
|-
|10||0x013928||6203||PCM Sound Effect||
|-
|11||0x015163||19699||PCM Sound Effect||
|-
|12||0x019E56||42261||PCM Sound Effect||
|-
|13||0x02436B||6169||PCM Sound Effect||
|-
|14||0x025B84||4318||PCM Sound Effect||
|-
|15||0x026C62||3702||PCM Sound Effect||
|-
|16||0x027AD8||7944||PCM Sound Effect||
|-
|17||0x0299E0||2167||PCM Sound Effect||
|-
|18||0x02A257||3006||PCM Sound Effect||
|-
|19||0x02AE15||4667||PCM Sound Effect||
|-
|20||0x02C050||7901||PCM Sound Effect||
|-
|21||0x02DF2D||5982||PCM Sound Effect||
|-
|22||0x02F68B||9396||PCM Sound Effect||
|-
|23||0x031B3F||156577||PCM Sound Effect||
|-
|24||0x057EE0||2715||PCM Sound Effect||
|-
|25||0x05897B||2608||PCM Sound Effect||
|-
|26||0x0593AB||3480||PCM Sound Effect||
|-
|27||0x05A143||6480||PCM Sound Effect||
|-
|28||0x05BA93||9771||PCM Sound Effect||
|-
|29||0x05E0BE||2284||PCM Sound Effect||
|-
|30||0x05E9AA||1435||PCM Sound Effect||
|-
|31||0x05EF45||39331||PCM Sound Effect||
|-
|32||0x0688E8||2177||PCM Sound Effect||
|-
|33||0x069169||12701||PCM Sound Effect||
|-
|34||0x06C306||1372||[[AdLib Instrument Bank Format]]||
|-
|35||0x06C862||1372||[[AdLib Instrument Bank Format]]||
|-
|36||0x06CDBE||1372||[[AdLib Instrument Bank Format]]||
|-
|37||0x06D31A||1372||[[AdLib Instrument Bank Format]]||
|-
|38||0x06D876||1372||[[AdLib Instrument Bank Format]]||
|-
|39||0x06DDD2||1372||[[AdLib Instrument Bank Format]]||
|-
|40||0x06E32E||1372||[[AdLib Instrument Bank Format]]||
|-
|41||0x06E88A||1372||[[AdLib Instrument Bank Format]]||
|-
|42||0x06EDE6||1372||[[AdLib Instrument Bank Format]]||
|-
|43||0x06F342||1372||[[AdLib Instrument Bank Format]]||
|-
|44||0x06F89E||1372||[[AdLib Instrument Bank Format]]||
|-
|45||0x06FDFA||1372||[[AdLib Instrument Bank Format]]||
|-
|46||0x070356||1372||[[AdLib Instrument Bank Format]]||
|-
|47||0x0708B2||1372||[[AdLib Instrument Bank Format]]||
|-
|48||0x070E0E||1372||[[AdLib Instrument Bank Format]]||
|-
|49||0x07136A||1372||[[AdLib Instrument Bank Format]]||
|-
|50||0x0718C6||1372||[[AdLib Instrument Bank Format]]||
|-
|51||0x071E22||14491||[[IMS Format]]||
|-
|52||0x0756BD||2179||[[IMS Format]]||
|-
|53||0x075F40||2416||[[IMS Format]]||
|-
|54||0x0768B0||438||[[IMS Format]]||
|-
|55||0x076A66||2836||[[IMS Format]]||
|-
|56||0x07757A||9280||[[IMS Format]]||
|-
|57||0x0799BA||4833||[[IMS Format]]||
|-
|58||0x07AC9B||4013||[[IMS Format]]||
|-
|59||0x07BC48||651||[[IMS Format]]||
|-
|60||0x07BED3||9877||[[IMS Format]]||
|-
|61||0x07E568||5364||[[IMS Format]]||
|-
|62||0x07FA5C||6790||[[IMS Format]]||
|-
|63||0x0814E2||8586||[[IMS Format]]||
|-
|64||0x08366C||7699||[[IMS Format]]||
|-
|65||0x08547F||15395||[[IMS Format]]||
|-
|66||0x0890A2||9218||[[IMS Format]]||
|-
|67||0x08B4A4||2843||[[IMS Format]]||
|-
|68||0x08BFBF||6790||[[IMS Format]]||
|-
|69||0x08DA45||15386||[[IMS Format]]||
|-
|70||0x09165F||3413||[[IMS Format]]||
|-
|71||0x0923B4||9087||[[IMS Format]]||
|-
|72||0x094733||7158||[[IMS Format]]||
|-
|73||0x096329||1372||[[AdLib Instrument Bank Format]]||
|-
|74||0x096885||1372||[[AdLib Instrument Bank Format]]||
|-
|75||0x096DE1||1372||[[AdLib Instrument Bank Format]]||
|-
|76||0x09733D||4837||[[IMS Format]]||
|-
|77||0x098622||1372||[[AdLib Instrument Bank Format]]||
|-
|78||0x098B7E||210650||unknown||
|}
PCM Sound Effects are raw 8-bit unsigned, but end with a 00 byte like [[VOC Format|VOC Files]].
There is one Timbre Bank (BNK) file for each IMS song. The first BNK belongs to the first IMS, the second BNK to the second IMS, etc.

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

ArtCraft Resource File Format

2016-03-05T12:03:32Z

ValleyBell: instrument banks are BNK Format

{{Archive Infobox
| MaxFiles = Set by FAT length
| FAT = External
| Names = Yes
| Metadata = None
| Subdirectories = N
| Compressed = N
| Encrypted = N
| Hidden = N
| Games =
{{Game|Lychnis}}
}}
The '''ArtCraft Resource File Format''' is used by games of the Korean developer Artcraft.
The format itself stores no offsets and/or file names. Instead, file tables are stored in the game EXE files.

The format is very similar to [[SoftMax Resource File Format]], which is used in the later released game [[Sky & Rica]].

== File format ==

=== Signature ===

Lychnis uses the following signature:
{|class="wikitable"
! Data type!!Name!!Description
|-
|BYTE[0x20]||cSignature||"(C) ArtCraft Resource File" 0x1A 0x00*5
|}

=== FAT ===
The File Allocation Table is stored in the game executables.

[[Lychnis]] separately stores a list of file names (13-character strings, NULL-terminated), a list of UINT32LE file offsets and a list of UINT32LE file sizes. The lists are stored consecutively and in that order. The main executable <tt>LYCHNIS.EXE</tt> only contains a FAT for <tt>LYCHNIS2.RES</tt>. The resource file itself contains other executables, which also only contain the FAT for one of the two resource files.

{|class="wikitable"
!EXE File!!Resource file!!Number of files!!File names!!File offsets!!File sizes
|-
|LYCHNIS.EXE||lychnis2.res||114||0x00ECC0||0x00F28A||0x00F452
|-
|LYCH1||lychnis1.res||226||0x014CD0||0x01584A||0x015BD2
|-
|LYCH1P||lychnis1.res||226||0x012D32||0x0138AC||0x013C34
|-
|LYCH2||lychnis1.res||226||0x016DEE||0x017968||0x017CF0
|-
|LYCH2P||lychnis1.res||226||0x01661C||0x017196||0x01751E
|-
|LYCH3||lychnis1.res||226||0x015564||0x0160DE||0x016466
|-
|LYCH3P||lychnis1.res||226||0x014D72||0x0158EC||0x015C74
|-
|LYCH4||lychnis1.res||226||0x01454E||0x0150C8||0x015450
|-
|LYCH5||lychnis1.res||226||0x014D70||0x0158EA||0x015C72
|-
|LYCHB6||lychnis2.res||114||0x00C8F8||0x00CEC2||0x00D08A
|-
|BONUS||lychnis1.res||226||0x01281C||0x013396||0x01371E
|}
The file tables match between all executables that use the same resource file.

== List of files ==

The following table lists the contents of <tt>LYCHNIS2.RES</tt>.
Game executables can be renamed to .exe and executed directly. They read the configuration file <tt>LYCH.CFG</tt> to get the level to load.
{|class="wikitable"
!File #!!Offset!!Size!!Filename!!Format!!Notes
|-
|0||0x000020||1372||MAP.BNK||[[AdLib Instrument Bank Format]]||
|-
|1||0x00057C||1372||OPENING1.BNK||[[AdLib Instrument Bank Format]]||
|-
|2||0x000AD8||1372||OPENING2.BNK||[[AdLib Instrument Bank Format]]||
|-
|3||0x001034||1372||P-SELECT.BNK||[[AdLib Instrument Bank Format]]||
|-
|4||0x001590||1372||SHOP.BNK||[[AdLib Instrument Bank Format]]||
|-
|5||0x001AEC||1372||SLOT.BNK||[[AdLib Instrument Bank Format]]||
|-
|6||0x002048||1372||STAFFROL.BNK||[[AdLib Instrument Bank Format]]||
|-
|7||0x0025A4||1372||TITLE2.BNK||[[AdLib Instrument Bank Format]]||
|-
|8||0x002B00||15497||MAP.IMS||[[IMS Format]]||
|-
|9||0x006789||9028||OPENING1.IMS||[[IMS Format]]||
|-
|10||0x008ACD||5150||OPENING2.IMS||[[IMS Format]]||
|-
|11||0x009EEB||5184||P-SELECT.IMS||[[IMS Format]]||
|-
|12||0x00B32B||9532||SHOP.IMS||[[IMS Format]]||
|-
|13||0x00D867||9395||SLOT.IMS||[[IMS Format]]||
|-
|14||0x00FD1A||20001||STAFFROL.IMS||[[IMS Format]]||
|-
|15||0x014B3B||6596||TITLE2.IMS||[[IMS Format]]||
|-
|16||0x0164FF||12583||DRAGON.PCX||[[PCX Format]]||
|-
|17||0x019626||16566||ENDBACK.PCX||[[PCX Format]]||
|-
|18||0x01D6DC||7529||LOGO.PCX||[[PCX Format]]||
|-
|19||0x01F445||23289||MAP.PCX||[[PCX Format]]||
|-
|20||0x024F3E||19887||OPBACK.PCX||[[PCX Format]]||
|-
|21||0x029CED||14145||OPGONG.PCX||[[PCX Format]]||
|-
|22||0x02D42E||14393||OPIRIS.PCX||[[PCX Format]]||
|-
|23||0x030C67||7152||OPLYCH.PCX||[[PCX Format]]||
|-
|24||0x032857||26316||PLS.PCX||[[PCX Format]]||
|-
|25||0x038F23||36965||SHOP.PCX||[[PCX Format]]||
|-
|26||0x041F88||41849||SLOTBOX.PCX||[[PCX Format]]||
|-
|27||0x04C301||18666||STAFFB.PCX||[[PCX Format]]||
|-
|28||0x050BEB||10158||TITLE1.PCX||[[PCX Format]]||
|-
|29||0x053399||11358||TITLE2.PCX||[[PCX Format]]||
|-
|30||0x055FF7||768||DRAGON.PAL||6-bit [[VGA Palette]]||
|-
|31||0x0562F7||768||ENDING.PAL||6-bit [[VGA Palette]]||
|-
|32||0x0565F7||768||LOGO.PAL||6-bit [[VGA Palette]]||
|-
|33||0x0568F7||768||MAP.PAL||6-bit [[VGA Palette]]||
|-
|34||0x056BF7||768||OPEN.PAL||6-bit [[VGA Palette]]||
|-
|35||0x056EF7||768||PLS.PAL||6-bit [[VGA Palette]]||
|-
|36||0x0571F7||768||SHOP.PAL||6-bit [[VGA Palette]]||
|-
|37||0x0574F7||768||SLOTBOX.PAL||6-bit [[VGA Palette]]||
|-
|38||0x0577F7||768||STAFFROL.PAL||6-bit [[VGA Palette]]||
|-
|39||0x057AF7||768||TITLE.PAL||6-bit [[VGA Palette]]||
|-
|40||0x057DF7||33418||CAST.SPR||[[NeoTouken Sprite Format]]||
|-
|41||0x060081||1581||CURSOR.SPR||[[NeoTouken Sprite Format]]||
|-
|42||0x0606AE||8197||ENDING.SPR||[[NeoTouken Sprite Format]]||
|-
|43||0x0626B3||1179||EYE.SPR||[[NeoTouken Sprite Format]]||
|-
|44||0x062B4E||13740||IRISTITL.SPR||[[NeoTouken Sprite Format]]||
|-
|45||0x0660FA||9719||KA.SPR||[[NeoTouken Sprite Format]]||
|-
|46||0x0686F1||6067||LYCHTITL.SPR||[[NeoTouken Sprite Format]]||
|-
|47||0x069EA4||3165||MAPFACE.SPR||[[NeoTouken Sprite Format]]||
|-
|48||0x06AB01||1526||MAPMARK.SPR||[[NeoTouken Sprite Format]]||
|-
|49||0x06B0F7||26795||NARR1.SPR||[[NeoTouken Sprite Format]]||
|-
|50||0x0719A2||22665||NARR2.SPR||[[NeoTouken Sprite Format]]||
|-
|51||0x07722B||14806||NARR3.SPR||[[NeoTouken Sprite Format]]||
|-
|52||0x07AC01||18584||NARR4.SPR||[[NeoTouken Sprite Format]]||
|-
|53||0x07F499||2064||NUMBER.SPR||[[NeoTouken Sprite Format]]||
|-
|54||0x07FCA9||11032||OPTION.SPR||[[NeoTouken Sprite Format]]||
|-
|55||0x0827C1||13260||OX.SPR||[[NeoTouken Sprite Format]]||
|-
|56||0x085B8D||33587||PLS.SPR||[[NeoTouken Sprite Format]]||
|-
|57||0x08DEC0||5187||ROCK.SPR||[[NeoTouken Sprite Format]]||
|-
|58||0x08F303||16277||SAKI.SPR||[[NeoTouken Sprite Format]]||
|-
|59||0x093298||4160||SHOPCOIN.SPR||[[NeoTouken Sprite Format]]||
|-
|60||0x0942D8||15214||SHOPFACE.SPR||[[NeoTouken Sprite Format]]||
|-
|61||0x097E46||29187||SHOPMSG.SPR||[[NeoTouken Sprite Format]]||
|-
|62||0x09F049||25144||SLOT.SPR||[[NeoTouken Sprite Format]]||
|-
|63||0x0A5281||6476||SLOTNUM.SPR||[[NeoTouken Sprite Format]]||
|-
|64||0x0A6BCD||34564||STAFFROL.SPR||[[NeoTouken Sprite Format]]||
|-
|65||0x0AF2D1||2316||T1.SPR||[[NeoTouken Sprite Format]]||
|-
|66||0x0AFBDD||1204||T2.SPR||[[NeoTouken Sprite Format]]||
|-
|67||0x0B0091||8937||TIT.SPR||[[NeoTouken Sprite Format]]||
|-
|68||0x0B237A||3240||TIT2.SPR||[[NeoTouken Sprite Format]]||
|-
|69||0x0B3022||8825||TIT3.SPR||[[NeoTouken Sprite Format]]||
|-
|70||0x0B529B||26018||WEAPON.SPR||[[NeoTouken Sprite Format]]||
|-
|71||0x0BB83D||4471||CHOICE.VOC||[[VOC Format]]||
|-
|72||0x0BC9B4||59631||LOGO.VOC||[[VOC Format]]||
|-
|73||0x0CB2A3||1523||SELECT.VOC||[[VOC Format]]||
|-
|74||0x0CB896||83066||BONUS||Game Executable||Bonus Stages
|-
|75||0x0DFD10||92462||LYCH1||Game Executable||Stages 1-x
|-
|76||0x0F663E||100940||LYCH2||Game Executable||Stages 2-x
|-
|77||0x10F08A||94658||LYCH3||Game Executable||Stages 3-x
|-
|78||0x12624C||90540||LYCH4||Game Executable||Stages 4-x
|-
|79||0x13C3F8||92622||LYCH5||Game Executable||Stages 5-x
|-
|80||0x152DC6||83048||LYCH1P||Game Executable||Stage 1-3 Demo Play (with Lychnis)
|-
|81||0x16722E||99264||LYCH2P||Game Executable||Stage 2-2 Demo Play (with Iris)
|-
|82||0x17F5EE||92950||LYCH3P||Game Executable||Stage 3-2 Demo Play (with Lychnis)
|-
|83||0x196104||768||STAGE5.PAL||6-bit [[VGA Palette]]||
|-
|84||0x196404||23859||ST6BS.PCX||[[PCX Format]]||
|-
|85||0x19C137||9010||BING.SPR||[[NeoTouken Sprite Format]]||
|-
|86||0x19E469||15009||BOSSSLOT.SPR||[[NeoTouken Sprite Format]]||
|-
|87||0x1A1F0A||6154||EFF1.SPR||[[NeoTouken Sprite Format]]||
|-
|88||0x1A3714||2221||EFF2.SPR||[[NeoTouken Sprite Format]]||
|-
|89||0x1A3FC1||17653||INFO6.SPR||[[NeoTouken Sprite Format]]||
|-
|90||0x1A84B6||28250||IRIS1.SPR||[[NeoTouken Sprite Format]]||
|-
|91||0x1AF310||11760||ITEM15.SPR||[[NeoTouken Sprite Format]]||
|-
|92||0x1B2100||10307||ITEM2.SPR||[[NeoTouken Sprite Format]]||
|-
|93||0x1B4943||30352||LYCHNIS1.SPR||[[NeoTouken Sprite Format]]||
|-
|94||0x1BBFD3||8627||MOLEN31.SPR||[[NeoTouken Sprite Format]]||
|-
|95||0x1BE186||53463||NBOSS6.SPR||[[NeoTouken Sprite Format]]||
|-
|96||0x1CB25D||7707||NBOSS622.SPR||[[NeoTouken Sprite Format]]||
|-
|97||0x1CD078||4982||NUMBER2.SPR||[[NeoTouken Sprite Format]]||
|-
|98||0x1CE3EE||5204||PPANG.SPR||[[NeoTouken Sprite Format]]||
|-
|99||0x1CF842||1372||CLEARSTG.BNK||[[AdLib Instrument Bank Format]]||
|-
|100||0x1CFD9E||1372||FINALBOS.BNK||[[AdLib Instrument Bank Format]]||
|-
|101||0x1D02FA||1372||CLEAR.BNK||[[AdLib Instrument Bank Format]]||
|-
|102||0x1D0856||1372||GAMEOVER.BNK||[[AdLib Instrument Bank Format]]||
|-
|103||0x1D0DB2||1496||CLEAR.IMS||[[IMS Format]]||
|-
|104||0x1D138A||52550||FINALBOS.IMS||[[IMS Format]]||
|-
|105||0x1DE0D0||3733||GAMEOVER.IMS||[[IMS Format]]||
|-
|106||0x1DEF65||4161||ATTACK.VOC||[[VOC Format]]||
|-
|107||0x1DFFA6||9783||BOMB.VOC||[[VOC Format]]||
|-
|108||0x1E25DD||5621||DEFENCE.VOC||[[VOC Format]]||
|-
|109||0x1E3BD2||5379||ITEM2.VOC||[[VOC Format]]||
|-
|110||0x1E50D5||1869||MAGIC1.VOC||[[VOC Format]]||
|-
|111||0x1E5822||15426||NPAUSE.VOC||[[VOC Format]]||
|-
|112||0x1E9464||2251||SWORD1.VOC||[[VOC Format]]||
|-
|113||0x1E9D2F||56368||LYCHB6||Game Executable||Final Boss
|}

The following table lists the contents of <tt>LYCHNIS1.RES</tt>.
{|class="wikitable"
!File #!!Offset!!Size!!Filename!!Format!!Notes
|-
|0||0x000020||239||STEP.VOC||[[VOC Format]]||
|-
|1||0x00010F||1523||SELECT.VOC||[[VOC Format]]||
|-
|2||0x000702||1869||MAGIC1.VOC||[[VOC Format]]||
|-
|3||0x000E4F||2251||SWORD1.VOC||[[VOC Format]]||
|-
|4||0x00171A||2797||BOPEN.VOC||[[VOC Format]]||
|-
|5||0x002207||2968||ZZZ.VOC||[[VOC Format]]||
|-
|6||0x002D9F||3296||ITEM.VOC||[[VOC Format]]||
|-
|7||0x003A7F||4161||ATTACK.VOC||[[VOC Format]]||
|-
|8||0x004AC0||4352||BIRD.VOC||[[VOC Format]]||
|-
|9||0x005BC0||4471||CHOICE.VOC||[[VOC Format]]||
|-
|10||0x006D37||5379||ITEM2.VOC||[[VOC Format]]||
|-
|11||0x00823A||5503||XITEM.VOC||[[VOC Format]]||
|-
|12||0x0097B9||5621||DEFENCE.VOC||[[VOC Format]]||
|-
|13||0x00ADAE||7047||COIN.VOC||[[VOC Format]]||
|-
|14||0x00C935||7476||1UP.VOC||[[VOC Format]]||
|-
|15||0x00E669||9783||BOMB.VOC||[[VOC Format]]||
|-
|16||0x010CA0||15426||NPAUSE.VOC||[[VOC Format]]||
|-
|17||0x0148E2||4377||BALL.SPR||[[NeoTouken Sprite Format]]||
|-
|18||0x0159FB||2323||BAT1.SPR||[[NeoTouken Sprite Format]]||
|-
|19||0x01630E||2339||BAT2.SPR||[[NeoTouken Sprite Format]]||
|-
|20||0x016C31||12780||BEAR1.SPR||[[NeoTouken Sprite Format]]||
|-
|21||0x019E1D||6658||CACTUS1.SPR||[[NeoTouken Sprite Format]]||
|-
|22||0x01B81F||6676||CACTUS2.SPR||[[NeoTouken Sprite Format]]||
|-
|23||0x01D233||3348||CONCH1.SPR||[[NeoTouken Sprite Format]]||
|-
|24||0x01DF47||4095||CRAB1.SPR||[[NeoTouken Sprite Format]]||
|-
|25||0x01EF46||4113||CRAB2.SPR||[[NeoTouken Sprite Format]]||
|-
|26||0x01FF57||3518||CRAW1.SPR||[[NeoTouken Sprite Format]]||
|-
|27||0x020D15||3444||CRAW2.SPR||[[NeoTouken Sprite Format]]||
|-
|28||0x021A89||8730||EFF1.SPR||[[NeoTouken Sprite Format]]||
|-
|29||0x023CA3||3253||EFF2.SPR||[[NeoTouken Sprite Format]]||
|-
|30||0x024958||6296||FBIRD1.SPR||[[NeoTouken Sprite Format]]||
|-
|31||0x0261F0||6442||FBIRD2.SPR||[[NeoTouken Sprite Format]]||
|-
|32||0x027B1A||6965||FIRE1.SPR||[[NeoTouken Sprite Format]]||
|-
|33||0x02964F||6967||FIRE2.SPR||[[NeoTouken Sprite Format]]||
|-
|34||0x02B186||6202||FROG1.SPR||[[NeoTouken Sprite Format]]||
|-
|35||0x02C9C0||6168||FROG2.SPR||[[NeoTouken Sprite Format]]||
|-
|36||0x02E1D8||2755||GRASS1.SPR||[[NeoTouken Sprite Format]]||
|-
|37||0x02EC9B||2745||GRASS2.SPR||[[NeoTouken Sprite Format]]||
|-
|38||0x02F754||3130||HEDGEN1.SPR||[[NeoTouken Sprite Format]]||
|-
|39||0x03038E||2447||HEDGEN2.SPR||[[NeoTouken Sprite Format]]||
|-
|40||0x030D1D||3438||HORSE1.SPR||[[NeoTouken Sprite Format]]||
|-
|41||0x031A8B||3262||HORSE2.SPR||[[NeoTouken Sprite Format]]||
|-
|42||0x032749||5783||ICICLE1.SPR||[[NeoTouken Sprite Format]]||
|-
|43||0x033DE0||20713||INFO1.SPR||[[NeoTouken Sprite Format]]||
|-
|44||0x038EC9||21209||INFO2.SPR||[[NeoTouken Sprite Format]]||
|-
|45||0x03E1A2||20315||INFO3.SPR||[[NeoTouken Sprite Format]]||
|-
|46||0x0430FD||20430||INFO4.SPR||[[NeoTouken Sprite Format]]||
|-
|47||0x0480CB||20895||INFO5.SPR||[[NeoTouken Sprite Format]]||
|-
|48||0x04D26A||22068||INFOB.SPR||[[NeoTouken Sprite Format]]||
|-
|49||0x05289E||20525||IRIS1.SPR||[[NeoTouken Sprite Format]]||
|-
|50||0x0578CB||20275||IRIS2.SPR||[[NeoTouken Sprite Format]]||
|-
|51||0x05C7FE||11949||ITEM11.SPR||[[NeoTouken Sprite Format]]||
|-
|52||0x05F6AB||11868||ITEM12.SPR||[[NeoTouken Sprite Format]]||
|-
|53||0x062507||12084||ITEM13.SPR||[[NeoTouken Sprite Format]]||
|-
|54||0x06543B||11929||ITEM14.SPR||[[NeoTouken Sprite Format]]||
|-
|55||0x0682D4||11760||ITEM15.SPR||[[NeoTouken Sprite Format]]||
|-
|56||0x06B0C4||11718||ITEM1B.SPR||[[NeoTouken Sprite Format]]||
|-
|57||0x06DE8A||10307||ITEM2.SPR||[[NeoTouken Sprite Format]]||
|-
|58||0x0706CD||3614||LIEBOX1.SPR||[[NeoTouken Sprite Format]]||
|-
|59||0x0714EB||3500||LIEBOX2.SPR||[[NeoTouken Sprite Format]]||
|-
|60||0x072297||21479||LYCHNIS1.SPR||[[NeoTouken Sprite Format]]||
|-
|61||0x07767E||22061||LYCHNIS2.SPR||[[NeoTouken Sprite Format]]||
|-
|62||0x07CCAB||1437||MAGIC10.SPR||[[NeoTouken Sprite Format]]||
|-
|63||0x07D248||1476||MAGIC11.SPR||[[NeoTouken Sprite Format]]||
|-
|64||0x07D80C||1863||MAGIC12.SPR||[[NeoTouken Sprite Format]]||
|-
|65||0x07DF53||1941||MAGIC13.SPR||[[NeoTouken Sprite Format]]||
|-
|66||0x07E6E8||2524||MAGIC14.SPR||[[NeoTouken Sprite Format]]||
|-
|67||0x07F0C4||1575||MAGIC20.SPR||[[NeoTouken Sprite Format]]||
|-
|68||0x07F6EB||1542||MAGIC21.SPR||[[NeoTouken Sprite Format]]||
|-
|69||0x07FCF1||1919||MAGIC22.SPR||[[NeoTouken Sprite Format]]||
|-
|70||0x080470||2029||MAGIC23.SPR||[[NeoTouken Sprite Format]]||
|-
|71||0x080C5D||2714||MAGIC24.SPR||[[NeoTouken Sprite Format]]||
|-
|72||0x0816F7||3360||MOLEGHO1.SPR||[[NeoTouken Sprite Format]]||
|-
|73||0x082417||3400||MOLEGHO2.SPR||[[NeoTouken Sprite Format]]||
|-
|74||0x08315F||8224||MOLEN1.SPR||[[NeoTouken Sprite Format]]||
|-
|75||0x08517F||8496||MOLEN2.SPR||[[NeoTouken Sprite Format]]||
|-
|76||0x0872AF||8604||MOLEN21.SPR||[[NeoTouken Sprite Format]]||
|-
|77||0x08944B||9244||MOLEN22.SPR||[[NeoTouken Sprite Format]]||
|-
|78||0x08B867||8627||MOLEN31.SPR||[[NeoTouken Sprite Format]]||
|-
|79||0x08DA1A||8557||MOLEN32.SPR||[[NeoTouken Sprite Format]]||
|-
|80||0x08FB87||6175||MOLEN41.SPR||[[NeoTouken Sprite Format]]||
|-
|81||0x0913A6||6489||MOLEN42.SPR||[[NeoTouken Sprite Format]]||
|-
|82||0x092CFF||2274||MOUSE1.SPR||[[NeoTouken Sprite Format]]||
|-
|83||0x0935E1||2270||MOUSE2.SPR||[[NeoTouken Sprite Format]]||
|-
|84||0x093EBF||5558||MUSHN1.SPR||[[NeoTouken Sprite Format]]||
|-
|85||0x095475||5614||MUSHN2.SPR||[[NeoTouken Sprite Format]]||
|-
|86||0x096A63||4982||NUMBER2.SPR||[[NeoTouken Sprite Format]]||
|-
|87||0x097DD9||5579||OWLN1.SPR||[[NeoTouken Sprite Format]]||
|-
|88||0x0993A4||6360||PELICAN1.SPR||[[NeoTouken Sprite Format]]||
|-
|89||0x09AC7C||6556||PELICAN2.SPR||[[NeoTouken Sprite Format]]||
|-
|90||0x09C618||10056||PENGUIN1.SPR||[[NeoTouken Sprite Format]]||
|-
|91||0x09ED60||9734||PENGUIN2.SPR||[[NeoTouken Sprite Format]]||
|-
|92||0x0A1366||6266||PUMPKIN1.SPR||[[NeoTouken Sprite Format]]||
|-
|93||0x0A2BE0||6256||PUMPKIN2.SPR||[[NeoTouken Sprite Format]]||
|-
|94||0x0A4450||1678||RAFT.SPR||[[NeoTouken Sprite Format]]||
|-
|95||0x0A4ADE||2989||RMOLE1.SPR||[[NeoTouken Sprite Format]]||
|-
|96||0x0A568B||2903||RMOLE2.SPR||[[NeoTouken Sprite Format]]||
|-
|97||0x0A61E2||3275||SALAMAN1.SPR||[[NeoTouken Sprite Format]]||
|-
|98||0x0A6EAD||3297||SALAMAN2.SPR||[[NeoTouken Sprite Format]]||
|-
|99||0x0A7B8E||2948||SCOLP1.SPR||[[NeoTouken Sprite Format]]||
|-
|100||0x0A8712||2908||SCOLP2.SPR||[[NeoTouken Sprite Format]]||
|-
|101||0x0A926E||4394||SKULL1.SPR||[[NeoTouken Sprite Format]]||
|-
|102||0x0AA398||4394||SKULL2.SPR||[[NeoTouken Sprite Format]]||
|-
|103||0x0AB4C2||3896||SNAIL1.SPR||[[NeoTouken Sprite Format]]||
|-
|104||0x0AC3FA||3886||SNAIL2.SPR||[[NeoTouken Sprite Format]]||
|-
|105||0x0AD328||5517||SNOWMAN1.SPR||[[NeoTouken Sprite Format]]||
|-
|106||0x0AE8B5||5649||SNOWMAN2.SPR||[[NeoTouken Sprite Format]]||
|-
|107||0x0AFEC6||4955||SPEAR1.SPR||[[NeoTouken Sprite Format]]||
|-
|108||0x0B1221||4955||SPEAR2.SPR||[[NeoTouken Sprite Format]]||
|-
|109||0x0B257C||1824||SWORD10.SPR||[[NeoTouken Sprite Format]]||
|-
|110||0x0B2C9C||1807||SWORD11.SPR||[[NeoTouken Sprite Format]]||
|-
|111||0x0B33AB||2496||SWORD12.SPR||[[NeoTouken Sprite Format]]||
|-
|112||0x0B3D6B||2536||SWORD13.SPR||[[NeoTouken Sprite Format]]||
|-
|113||0x0B4753||2945||SWORD14.SPR||[[NeoTouken Sprite Format]]||
|-
|114||0x0B52D4||3126||SWORD15.SPR||[[NeoTouken Sprite Format]]||
|-
|115||0x0B5F0A||1952||SWORD20.SPR||[[NeoTouken Sprite Format]]||
|-
|116||0x0B66AA||1933||SWORD21.SPR||[[NeoTouken Sprite Format]]||
|-
|117||0x0B6E37||2660||SWORD22.SPR||[[NeoTouken Sprite Format]]||
|-
|118||0x0B789B||2682||SWORD23.SPR||[[NeoTouken Sprite Format]]||
|-
|119||0x0B8315||3065||SWORD24.SPR||[[NeoTouken Sprite Format]]||
|-
|120||0x0B8F0E||3212||SWORD25.SPR||[[NeoTouken Sprite Format]]||
|-
|121||0x0B9B9A||2062||TRAIN.SPR||[[NeoTouken Sprite Format]]||
|-
|122||0x0BA3A8||7496||TREE1.SPR||[[NeoTouken Sprite Format]]||
|-
|123||0x0BC0F0||7470||TREE2.SPR||[[NeoTouken Sprite Format]]||
|-
|124||0x0BDE1E||5645||TURTLE1.SPR||[[NeoTouken Sprite Format]]||
|-
|125||0x0BF42B||5791||TURTLE2.SPR||[[NeoTouken Sprite Format]]||
|-
|126||0x0C0ACA||2673||VOLCANO.SPR||[[NeoTouken Sprite Format]]||
|-
|127||0x0C153B||9991||ZOMBIE1.SPR||[[NeoTouken Sprite Format]]||
|-
|128||0x0C3C42||10135||ZOMBIE2.SPR||[[NeoTouken Sprite Format]]||
|-
|129||0x0C63D9||2555||BONUS1.SCR||[[ArtCraft Script Format]]??||
|-
|130||0x0C6DD4||2589||BONUS2.SCR||[[ArtCraft Script Format]]??||
|-
|131||0x0C77F1||542||BONUS3.SCR||[[ArtCraft Script Format]]??||
|-
|132||0x0C7A0F||534||BONUS4.SCR||[[ArtCraft Script Format]]??||
|-
|133||0x0C7C25||3342||ST1-1H.SCR||[[ArtCraft Script Format]]??||
|-
|134||0x0C8933||3505||ST1-1N.SCR||[[ArtCraft Script Format]]??||
|-
|135||0x0C96E4||3773||ST1-2H.SCR||[[ArtCraft Script Format]]??||
|-
|136||0x0CA5A1||3316||ST1-2N.SCR||[[ArtCraft Script Format]]??||
|-
|137||0x0CB295||4523||ST1-3H.SCR||[[ArtCraft Script Format]]??||
|-
|138||0x0CC440||4564||ST1-3N.SCR||[[ArtCraft Script Format]]??||
|-
|139||0x0CD614||4926||ST2-1H.SCR||[[ArtCraft Script Format]]??||
|-
|140||0x0CE952||4206||ST2-1N.SCR||[[ArtCraft Script Format]]??||
|-
|141||0x0CF9C0||4648||ST2-2H.SCR||[[ArtCraft Script Format]]??||
|-
|142||0x0D0BE8||4642||ST2-2N.SCR||[[ArtCraft Script Format]]??||
|-
|143||0x0D1E0A||4898||ST2-3H.SCR||[[ArtCraft Script Format]]??||
|-
|144||0x0D312C||4296||ST2-3N.SCR||[[ArtCraft Script Format]]??||
|-
|145||0x0D41F4||3100||ST3-1H.SCR||[[ArtCraft Script Format]]??||
|-
|146||0x0D4E10||2374||ST3-1N.SCR||[[ArtCraft Script Format]]??||
|-
|147||0x0D5756||4500||ST3-2H.SCR||[[ArtCraft Script Format]]??||
|-
|148||0x0D68EA||4572||ST3-2N.SCR||[[ArtCraft Script Format]]??||
|-
|149||0x0D7AC6||3676||ST3-3H.SCR||[[ArtCraft Script Format]]??||
|-
|150||0x0D8922||3619||ST3-3N.SCR||[[ArtCraft Script Format]]??||
|-
|151||0x0D9745||2999||ST4-1H.SCR||[[ArtCraft Script Format]]??||
|-
|152||0x0DA2FC||2658||ST4-1N.SCR||[[ArtCraft Script Format]]??||
|-
|153||0x0DAD5E||2305||ST4-2H.SCR||[[ArtCraft Script Format]]??||
|-
|154||0x0DB65F||1817||ST4-2N.SCR||[[ArtCraft Script Format]]??||
|-
|155||0x0DBD78||4032||ST4-3H.SCR||[[ArtCraft Script Format]]??||
|-
|156||0x0DCD38||4143||ST4-3N.SCR||[[ArtCraft Script Format]]??||
|-
|157||0x0DDD67||4087||ST5-1H.SCR||[[ArtCraft Script Format]]??||
|-
|158||0x0DED5E||3097||ST5-1N.SCR||[[ArtCraft Script Format]]??||
|-
|159||0x0DF977||1081||ST5-2H.SCR||[[ArtCraft Script Format]]??||
|-
|160||0x0DFDB0||1100||ST5-2N.SCR||[[ArtCraft Script Format]]??||
|-
|161||0x0E01FC||4854||ST5-3H.SCR||[[ArtCraft Script Format]]??||
|-
|162||0x0E14F2||5055||ST5-3N.SCR||[[ArtCraft Script Format]]??||
|-
|163||0x0E28B1||768||STAGE1.PAL||6-bit [[VGA Palette]]||
|-
|164||0x0E2BB1||768||STAGE2.PAL||6-bit [[VGA Palette]]||
|-
|165||0x0E2EB1||768||STAGE3.PAL||6-bit [[VGA Palette]]||
|-
|166||0x0E31B1||768||STAGE4.PAL||6-bit [[VGA Palette]]||
|-
|167||0x0E34B1||768||STAGE5.PAL||6-bit [[VGA Palette]]||
|-
|168||0x0E37B1||22465||BONUSSTG.IMS||[[IMS Format]]||
|-
|169||0x0E8F72||1496||CLEAR.IMS||[[IMS Format]]||
|-
|170||0x0E954A||3733||GAMEOVER.IMS||[[IMS Format]]||
|-
|171||0x0EA3DF||24704||LYCH0001.IMS||[[IMS Format]]||
|-
|172||0x0F045F||31708||LYCH0002.IMS||[[IMS Format]]||
|-
|173||0x0F803B||35483||LYCH0003.IMS||[[IMS Format]]||
|-
|174||0x100AD6||34069||LYCH0004.IMS||[[IMS Format]]||
|-
|175||0x108FEB||42622||LYCH0005.IMS||[[IMS Format]]||
|-
|176||0x113669||1372||BONUSSTG.BNK||[[AdLib Instrument Bank Format]]||
|-
|177||0x113BC5||1372||CLEAR.BNK||[[AdLib Instrument Bank Format]]||
|-
|178||0x114121||1372||GAMEOVER.BNK||[[AdLib Instrument Bank Format]]||
|-
|179||0x11467D||1372||LYCH0001.BNK||[[AdLib Instrument Bank Format]]||
|-
|180||0x114BD9||1372||LYCH0002.BNK||[[AdLib Instrument Bank Format]]||
|-
|181||0x115135||1372||LYCH0003.BNK||[[AdLib Instrument Bank Format]]||
|-
|182||0x115691||1372||LYCH0004.BNK||[[AdLib Instrument Bank Format]]||
|-
|183||0x115BED||1372||LYCH0005.BNK||[[AdLib Instrument Bank Format]]||
|-
|184||0x116149||24032||BONUS1.MAP||[[ArtCraft Level Map]]||
|-
|185||0x11BF29||8032||BONUS2.MAP||[[ArtCraft Level Map]]||
|-
|186||0x11DE89||4032||BONUS3.MAP||[[ArtCraft Level Map]]||
|-
|187||0x11EE49||20032||BONUS4.MAP||[[ArtCraft Level Map]]||
|-
|188||0x123C89||10272||STAGE1-1.MAP||[[ArtCraft Level Map]]||
|-
|189||0x1264A9||64032||STAGE1-2.MAP||[[ArtCraft Level Map]]||
|-
|190||0x135EC9||32432||STAGE1-3.MAP||[[ArtCraft Level Map]]||
|-
|191||0x13DD79||50032||STAGE2-1.MAP||[[ArtCraft Level Map]]||
|-
|192||0x14A0E9||64032||STAGE2-2.MAP||[[ArtCraft Level Map]]||
|-
|193||0x159B09||40032||STAGE2-3.MAP||[[ArtCraft Level Map]]||
|-
|194||0x163769||42032||STAGE3-1.MAP||[[ArtCraft Level Map]]||
|-
|195||0x16DB99||64032||STAGE3-2.MAP||[[ArtCraft Level Map]]||
|-
|196||0x17D5B9||64032||STAGE3-3.MAP||[[ArtCraft Level Map]]||
|-
|197||0x18CFD9||60032||STAGE4-1.MAP||[[ArtCraft Level Map]]||
|-
|198||0x19BA59||64032||STAGE4-2.MAP||[[ArtCraft Level Map]]||
|-
|199||0x1AB479||48032||STAGE4-3.MAP||[[ArtCraft Level Map]]||
|-
|200||0x1B7019||20032||STAGE5-1.MAP||[[ArtCraft Level Map]]||
|-
|201||0x1BBE59||36032||STAGE5-2.MAP||[[ArtCraft Level Map]]||
|-
|202||0x1C4B19||24032||STAGE5-3.MAP||[[ArtCraft Level Map]]||
|-
|203||0x1CA8F9||131102||BONUS1.DAT||[[ArtCraft Stage Tiles]]||
|-
|204||0x1EA917||131102||BONUS2.DAT||[[ArtCraft Stage Tiles]]||
|-
|205||0x20A935||131102||BONUS3.DAT||[[ArtCraft Stage Tiles]]||
|-
|206||0x22A953||131102||BONUS4.DAT||[[ArtCraft Stage Tiles]]||
|-
|207||0x24A971||131102||STAGE1-1.DAT||[[ArtCraft Stage Tiles]]||
|-
|208||0x26A98F||131102||STAGE1-2.DAT||[[ArtCraft Stage Tiles]]||
|-
|209||0x28A9AD||131102||STAGE1-3.DAT||[[ArtCraft Stage Tiles]]||
|-
|210||0x2AA9CB||131102||STAGE2-1.DAT||[[ArtCraft Stage Tiles]]||
|-
|211||0x2CA9E9||131102||STAGE2-2.DAT||[[ArtCraft Stage Tiles]]||
|-
|212||0x2EAA07||131102||STAGE2-3.DAT||[[ArtCraft Stage Tiles]]||
|-
|213||0x30AA25||131102||STAGE3-1.DAT||[[ArtCraft Stage Tiles]]||
|-
|214||0x32AA43||131102||STAGE3-2.DAT||[[ArtCraft Stage Tiles]]||
|-
|215||0x34AA61||131102||STAGE3-3.DAT||[[ArtCraft Stage Tiles]]||
|-
|216||0x36AA7F||131102||STAGE4-1.DAT||[[ArtCraft Stage Tiles]]||
|-
|217||0x38AA9D||131102||STAGE4-2.DAT||[[ArtCraft Stage Tiles]]||
|-
|218||0x3AAABB||131102||STAGE4-3.DAT||[[ArtCraft Stage Tiles]]||
|-
|219||0x3CAAD9||131102||STAGE5-1.DAT||[[ArtCraft Stage Tiles]]||
|-
|220||0x3EAAF7||131102||STAGE5-2.DAT||[[ArtCraft Stage Tiles]]||
|-
|221||0x40AB15||131102||STAGE5-3.DAT||[[ArtCraft Stage Tiles]]||
|-
|222||0x42AB33||15000||ST1-3N.MAC||Recorded keys for demo playback||
|-
|223||0x42E5CB||15000||ST2-2N.MAC||Recorded keys for demo playback||
|-
|224||0x432063||15000||ST3-2N.MAC||Recorded keys for demo playback||
|-
|225||0x435AFB||15000||ST4-1N.MAC||Recorded keys for demo playback||unused as there is no LYCH4P executable
|}

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

IMS Format

2016-03-05T12:01:21Z

ValleyBell: instrument banks are BNK Format

{{Music Infobox
| Type = MIDI
| Instruments = OPL
| NumChannels = 9 or 11
| NumTracks = 1
| NumPatterns = 1
| NumOrders = 0
| Tags = Title
| Games =
{{Game|Dragon Slayer: The Legend of Heroes}}
{{Game|Eol!}}
{{Game|Illusion Blaze}}
{{Game|Iron Blood}}
{{Game|Lychnis}}
{{Game|Olmang Jolmang Paradise}}
{{Game|Pee and Gity}}
{{Game|Reon-ui Moheom}}
{{Game|Shakii The Wolf}}
{{Game|Sky & Rica}}
{{Game|Vanslug: X Mission}}
}}
The '''IMS Format''' is an Ad Lib music format, based on the standard MIDI format. It is commonly seen in Korean DOS games.

The format is very similar to the [[AdLib MIDI Format]], but has an additional instrument table appended.
The instruments themselves are stored in a separate instrument bank in [[AdLib Instrument Bank Format]].

== File format ==

The file consists of a MIDI part that mostly matches the AdLib MIDI Format v1.0 and an instrument table that tells the player what instruments are to be loaded.

The instrument table is appended to the end of the MIDI data and has the following header:

{|class="wikitable"
! Data type !! Name !! Description
|-
| BYTE[2] || cSignature || 0x77 0x77 ("ww")
|-
| UINT16LE || numInstruments || Number of instruments used by the song
|}

This is followed by a list of instrument names, repeated <tt>numInstruments</tt> times:

{|class="wikitable"
! Data type !! Name !! Description
|-
| char[9] || name || Instrument name - must be NULL-terminated
|}

Each of the instrument names refers to the name of an instrument of an external instrument bank.

=== MIDI Commands ===
* Except for 8#, all commands match the [[AdLib MIDI Format]].
* As with usual MIDI files, the "running status" is supported for commands 8#..E#.

{| class="wikitable" |
! MIDI message !! Meaning !! Notes
|-
|8# nn vv||Note Retrigger||Stops the current note, then plays a new note if (vv > 0)
|-
|9# nn vv||Note On||Plays a note (vv > 0) or stops it (vv = 0)
|-
|A# vv||Volume Change||Changes the volume of the current note (also works after Note Off)
|-
|B# xx xx||ignored||MIDI Control Change
|-
|C# ii||Instrument Change||references an instrument from the instrument table
|-
|D# xx||ignored||MIDI Channel Aftertouch
|-
|E# ll mm||Pitch Bend||usual MIDI pitch bend, usually in the range of 1 semitone up/down
|-
|F0 7F 00 ii ff F7||Tempo Change||new Tempo = Initial Tempo * (ii + ff/0x80)
|-
|F0 xx ... xx F7||ignored||MIDI SysEx (without length)
|-
|F8||Delay Overflow||causes a delay of 240 ticks
|-
|FC||Song End||stops the song or restarts it from the beginning if looping is enabled
|}

== Tools ==

{{BeginFileFormatTools|Type=audio}}
{{FileFormatTool
| Name = [http://ulisu.egloos.com/1236597 OCPlay]
| Platform = DOS
| canPlay = Yes
| canCreate = No
| canModify = No
| canExport = No
| canImport = No
| editHidden = No
| editMetadata = No
| notes =
}}
{{EndFileFormatTools}}

== Credits ==

This file format was reverse engineered by [[User:ValleyBell|Valley Bell]] from IMS songs used by [[Family Production]] games and by disassembling [[Lychnis]]. 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!)

Also thanks to MaliceX for helping to identify games that use IMS songs.

SoftMax Resource File Format

2016-03-05T08:48:55Z

ValleyBell: Initial version

{{Archive Infobox
| MaxFiles = Set by FAT length
| FAT = External
| Names = N
| Metadata = None
| Subdirectories = N
| Compressed = N
| Encrypted = N
| Hidden = N
| Games =
{{Game|Sky & Rica}}
}}
The '''ArtCraft Resource File Format''' is used by games of the Korean developer Artcraft.
The format itself stores no offsets and/or file names. Instead, potential file tables are stored in the game EXE files or are even calculated using formulas.

The format is very similar to [[ArtCraft Resource File Format]], which is used in the earlier released game [[Lychnis]].

== File format ==

=== Signature ===

Sky & Rica uses the following signature:
{|class="wikitable"
! Data type!!Name!!Description
|-
|BYTE[0x20]||cSignature||"(C) SoftMax Resource File" 0x1A 0x00*6
|}

=== FAT ===
The File Allocation Table, if available, is stored in the game executables.

[[Sky & Rica]] (unlike Lychnis) stores only very few information about the resource files. For most of the files, there is only a list of UINT32LE file offsets. For the sound effects, there is an additional UINT32LE list of file sizes. For some files, offsets are calculated by the game.
S&R.EXE and SETUP.EXE don't use resource files.

{|class="wikitable"
!EXE File!!Resource file!!Number of files!!File offsets!!File sizes!!File type
|-
|rowspan="5"|FRAME.EXE ||s&r4.res||135*||0x011A84|| -- ||Sprites
|-
| s&r1.res|| 10*||0x01242C|| -- ||Cutscene Data?
|-
| s&r2.res|| 10*||0x012454|| -- ||Cutscene Data?
|-
| s&r5.res|| 44*||0x012700|| -- ||Music
|-
| s&r5.res|| 33 ||0x012806||0x01288A||Sound Effects
|-
|rowspan="3"|STAGE1.EXE||s&r4.res||120 ||0x012F9C|| -- ||Sprites
|-
| s&r5.res|| 42 ||0x013DAA|| -- ||Music
|-
| s&r5.res|| 34*||0x013EA8||0x013F34||Sound Effects
|-
|rowspan="3"|STAGE2.EXE||s&r4.res||132 ||0x01305C|| -- ||Sprites
|-
| s&r5.res|| 34 ||0x013E6A|| -- ||Music
|-
| s&r5.res|| 34*||0x013FBC||0x014048||Sound Effects
|-
|rowspan="3"|STAGE3.EXE||s&r4.res||120 ||0x012224|| -- ||Sprites
|-
| s&r5.res|| 42 ||0x013028|| -- ||Music
|-
| s&r5.res|| 34*||0x013126||0x0131B2||Sound Effects
|-
|rowspan="3"|STAGE4.EXE||s&r4.res||120 ||0x013994|| -- ||Sprites
|-
| s&r5.res|| 34 ||0x0147D2|| -- ||Music
|-
| s&r5.res|| 34*||0x014924||0x0149B0||Sound Effects
|-
|rowspan="3"|STAGE5.EXE||s&r4.res||133 ||0x0138C4|| -- ||Sprites
|-
| s&r5.res|| 34 ||0x0146D8|| -- ||Music
|-
| s&r5.res|| 34*||0x01482A||0x0148B6||Sound Effects
|-
|rowspan="3"|STAGE6.EXE||s&r4.res||120 ||0x0121B4|| -- ||Sprites
|-
| s&r5.res|| 44*||0x012FCC|| -- ||Music
|-
| s&r5.res|| 34*||0x0130CA||0x013156||Sound Effects
|-
|rowspan="3"|STAGE7.EXE||s&r4.res||120 ||0x013754|| -- ||Sprites
|-
| s&r5.res|| 34 ||0x014558|| -- ||Music
|-
| s&r5.res|| 34*||0x0146AA||0x014736||Sound Effects
|-
|rowspan="3"|STAGE9.EXE||s&r4.res||134 ||0x011CE4|| -- ||Sprites
|-
| s&r5.res|| 34 ||0x012AFA|| -- ||Music
|-
| s&r5.res|| 34*||0x012C4C||0x012CD8||Sound Effects
|-
|rowspan="3"|TITLE.EXE ||s&r4.res||120 ||0x0088A6|| -- ||Sprites
|-
| s&r5.res|| 34 ||0x008F2A|| -- ||Music
|-
| s&r5.res|| 34*||0x00907C||0x009108||Sound Effects
|}
It should be noted that not all executables have full file tables. For example, <tt>TITLE.EXE</tt> doesn't have all music offsets, but the SFX list is complete. <tt>FRAME.EXE</tt> has all music offsets, but lacks one sound effect.
All complete tables are marked with a *.

Sound Effects are raw 8-bit unsigned PCM. Music consists of IMS and BNK files.

== List of files ==

The following table lists the contents of <tt>S&R1.RES</tt>.
{|class="wikitable"
!File #!!Offset!!Size!!Format!!Notes
|-
|0||0x000020||887935||unknown||
|-
|1||0x0D8C9F||333482||unknown||
|-
|2||0x12A349||27524||unknown||
|-
|3||0x130ECD||22472||unknown||
|-
|4||0x136695||402640||unknown||
|-
|5||0x198B65||137224||unknown||
|-
|6||0x1BA36D||296062||unknown||
|-
|7||0x2027EB||126749||unknown||
|-
|8||0x221708||183262||unknown||
|-
|9||0x24E2E6||143358||unknown||
|}

The following table lists the contents of <tt>S&R2.RES</tt>.
{|class="wikitable"
!File #!!Offset!!Size!!Format!!Notes
|-
|0||0x000020||204805||unknown||
|-
|1||0x032025||665605||unknown||
|-
|2||0x0D482A||65413||unknown||
|-
|3||0x0E47AF||422061||unknown||
|-
|4||0x14B85C||363058||unknown||
|-
|5||0x1A428E||237377||unknown||
|-
|6||0x1DE1CF||446701||unknown||
|-
|7||0x24B2BC||447507||unknown||
|-
|8||0x2B86CF||66560||unknown||
|-
|9||0x2C8ACF||189980||unknown||
|}

The following table lists the contents of <tt>S&R3.RES</tt>.
{|class="wikitable"
!File #!!Offset!!Size!!Format!!Notes
|-
|0||0x000020||6752||Map Data||Title Screen
|-
|1||0x001A80||16128||Map Data||Stage 1
|-
|2||0x005980||16128||Map Data||Stage 2
|-
|3||0x009880||14528||Map Data||Stage 3
|-
|4||0x00D140||16128||Map Data||Stage 4
|-
|5||0x011040||16128||Map Data||Stage 5
|-
|6||0x014F40||16128||Map Data||Stage 6
|-
|7||0x018E40||14368||Map Data||Stage 7
|-
|8||0x01C660||75904||Tile Data||Title Screen
|-
|9||0x02EEE0||216192||Tile Data||Stage 1
|-
|10||0x063B60||252032||Tile Data||Stage 2
|-
|11||0x0A13E0||400768||Tile Data||Stage 3
|-
|12||0x103160||232064||Tile Data||Stage 4
|-
|13||0x13BBE0||173440||Tile Data||Stage 5
|-
|14||0x166160||236928||Tile Data||Stage 6
|-
|15||0x19FEE0||330368||Tile Data||Stage 7
|-
|16||0x1F0960||16896||Map Data||Stage 9
|-
|17||0x1F4B60||252032||Tile Data||Stage 9
|}
Since all of the offsets are hardcoded into the game executables, I searched for magic bytes.
Those were "Map File" and "Tile File" for map and tile data respectively. Both file types also contain the string "Innovation! 1994".
In the <tt>STAGE#.EXE</tt> files the offsets can be located by searching for the following magic bytes: 
Map Data (4-byte offset): <tt>F8 89 46 F6 6A 00 66 68 xx xx xx xx</tt> 
Map Data (1-byte offset): <tt>F8 89 46 F6 6A 00 66 6A xx</tt> 
Tile Data (4-byte offset): <tt>FA 89 46 F8 6A 00 66 68 xx xx xx xx</tt>

The following table lists the contents of <tt>S&R4.RES</tt>.
{|class="wikitable"
!File #!!Offset!!Size!!Format!!Notes
|-
|0||0x000020||11367||Sprite Data||
|-
|1||0x002C87||9268||Sprite Data||
|-
|2||0x0050BB||34823||Sprite Data||
|-
|3||0x00D8C2||25280||Sprite Data||
|-
|4||0x013B82||7640||Sprite Data||
|-
|5||0x01595A||14302||Sprite Data||
|-
|6||0x019138||28980||Sprite Data||
|-
|7||0x02026C||14448||Sprite Data||
|-
|8||0x023ADC||4435||Sprite Data||
|-
|9||0x024C2F||13515||Sprite Data||
|-
|10||0x0280FA||10548||Sprite Data||
|-
|11||0x02AA2E||13956||Sprite Data||
|-
|12||0x02E0B2||5752||Sprite Data||
|-
|13||0x02F72A||10245||Sprite Data||
|-
|14||0x031F2F||3846||Sprite Data||
|-
|15||0x032E35||16144||Sprite Data||
|-
|16||0x036D45||11848||Sprite Data||
|-
|17||0x039B8D||7194||Sprite Data||
|-
|18||0x03B7A7||8642||Sprite Data||
|-
|19||0x03D969||13390||Sprite Data||
|-
|20||0x040DB7||12972||Sprite Data||
|-
|21||0x044063||6822||Sprite Data||
|-
|22||0x045B09||7216||Sprite Data||
|-
|23||0x047739||15168||Sprite Data||
|-
|24||0x04B279||40454||Sprite Data||
|-
|25||0x05507F||10136||Sprite Data||
|-
|26||0x057817||7347||Sprite Data||
|-
|27||0x0594CA||7566||Sprite Data||
|-
|28||0x05B258||5436||Sprite Data||
|-
|29||0x05C794||8796||Sprite Data||
|-
|30||0x05E9F0||9283||Sprite Data||
|-
|31||0x060E33||3717||Sprite Data||
|-
|32||0x061CB8||11706||Sprite Data||
|-
|33||0x064A72||13298||Sprite Data||
|-
|34||0x067E64||11108||Sprite Data||
|-
|35||0x06A9C8||3417||Sprite Data||
|-
|36||0x06B721||39070||Sprite Data||
|-
|37||0x074FBF||5588||Sprite Data||
|-
|38||0x076593||8923||Sprite Data||
|-
|39||0x07886E||5450||Sprite Data||
|-
|40||0x079DB8||11653||Sprite Data||
|-
|41||0x07CB3D||53464||Sprite Data||
|-
|42||0x089C15||11620||Sprite Data||
|-
|43||0x08C979||6494||Sprite Data||
|-
|44||0x08E2D7||3146||Sprite Data||
|-
|45||0x08EF21||20656||Sprite Data||
|-
|46||0x093FD1||1922||Sprite Data||
|-
|47||0x094753||17723||Sprite Data||
|-
|48||0x098C8E||8592||Sprite Data||
|-
|49||0x09AE1E||5013||Sprite Data||
|-
|50||0x09C1B3||34029||Sprite Data||
|-
|51||0x0A46A0||26605||Sprite Data||
|-
|52||0x0AAE8D||4276||Sprite Data||
|-
|53||0x0ABF41||35885||Sprite Data||
|-
|54||0x0B4B6E||47021||Sprite Data||
|-
|55||0x0C031B||7005||Sprite Data||
|-
|56||0x0C1E78||26605||Sprite Data||
|-
|57||0x0C8665||26605||Sprite Data||
|-
|58||0x0CEE52||34029||Sprite Data||
|-
|59||0x0D733F||1958||Sprite Data||
|-
|60||0x0D7AE5||3584||Sprite Data||
|-
|61||0x0D88E5||2789||Sprite Data||
|-
|62||0x0D93CA||7121||Sprite Data||
|-
|63||0x0DAF9B||13715||Sprite Data||
|-
|64||0x0DE52E||21591||Sprite Data||
|-
|65||0x0E3985||9948||Sprite Data||
|-
|66||0x0E6061||7054||Sprite Data||
|-
|67||0x0E7BEF||4680||Sprite Data||
|-
|68||0x0E8E37||3378||Sprite Data||
|-
|69||0x0E9B69||5103||Sprite Data||
|-
|70||0x0EAF58||6835||Sprite Data||
|-
|71||0x0ECA0B||9360||Sprite Data||
|-
|72||0x0EEE9B||172253||Sprite Data||
|-
|73||0x118F78||147305||Sprite Data||
|-
|74||0x13CEE1||19053||Sprite Data||
|-
|75||0x14194E||1787||Sprite Data||
|-
|76||0x142049||1513||Sprite Data||
|-
|77||0x142632||4962||Sprite Data||
|-
|78||0x143994||10437||Sprite Data||
|-
|79||0x146259||6622||Sprite Data||
|-
|80||0x147C37||3464||Sprite Data||
|-
|81||0x1489BF||4085||Sprite Data||
|-
|82||0x1499B4||27629||Sprite Data||
|-
|83||0x1505A1||19785||Sprite Data||
|-
|84||0x1552EA||4164||Sprite Data||
|-
|85||0x15632E||17084||Sprite Data||
|-
|86||0x15A5EA||13467||Sprite Data||
|-
|87||0x15DA85||7184||Sprite Data||
|-
|88||0x15F695||44831||Sprite Data||
|-
|89||0x16A5B4||8968||Sprite Data||
|-
|90||0x16C8BC||63467||Sprite Data||
|-
|91||0x17C0A7||8856||Sprite Data||
|-
|92||0x17E33F||6715||Sprite Data||
|-
|93||0x17FD7A||4050||Sprite Data||
|-
|94||0x180D4C||1355||Sprite Data||
|-
|95||0x181297||12398||Sprite Data||
|-
|96||0x184305||16593||Sprite Data||
|-
|97||0x1883D6||108061||Sprite Data||
|-
|98||0x1A29F3||3604||Sprite Data||
|-
|99||0x1A3807||33899||Sprite Data||
|-
|100||0x1ABC72||16701||Sprite Data||
|-
|101||0x1AFDAF||63112||Sprite Data||
|-
|102||0x1BF437||9400||Sprite Data||
|-
|103||0x1C18EF||4269||Sprite Data||
|-
|104||0x1C299C||6613||Sprite Data||
|-
|105||0x1C4371||44437||Sprite Data||
|-
|106||0x1CF106||3259||Sprite Data||
|-
|107||0x1CFDC1||7243||Sprite Data||
|-
|108||0x1D1A0C||11166||Sprite Data||
|-
|109||0x1D45AA||48331||Sprite Data||
|-
|110||0x1E0275||3010||Sprite Data||
|-
|111||0x1E0E37||83755||Sprite Data||
|-
|112||0x1F5562||10248||Sprite Data||
|-
|113||0x1F7D6A||3729||Sprite Data||
|-
|114||0x1F8BFB||7018||Sprite Data||
|-
|115||0x1FA765||14275||Sprite Data||
|-
|116||0x1FDF28||3192||Sprite Data||
|-
|117||0x1FEBA0||8064||Sprite Data||
|-
|118||0x200B20||7931||Sprite Data||
|-
|119||0x202A1B||6108||Sprite Data||
|-
|120||0x2041F7||18091||Sprite Data||
|-
|121||0x2088A2||118034||Sprite Data||
|-
|122||0x2255B4||31292||Sprite Data||
|-
|123||0x22CFF0||1484||Sprite Data||
|-
|124||0x22D5BC||4637||Sprite Data||
|-
|125||0x22E7D9||7771||Sprite Data||
|-
|126||0x230634||3980||Sprite Data||
|-
|127||0x2315C0||27329||Sprite Data||
|-
|128||0x238081||11086||Sprite Data||
|-
|129||0x23ABCF||4631||Sprite Data||
|-
|130||0x23BDE6||1417||Sprite Data||
|-
|131||0x23C36F||16593||Sprite Data||
|-
|132||0x240440||33899||Sprite Data||
|-
|133||0x2488AB||39938||Sprite Data||
|-
|134||0x2524AD||8222||Sprite Data||
|}

The following table lists the contents of <tt>S&R5.RES</tt>.
{|class="wikitable"
!File #!!Offset!!Size!!Format!!Notes
|-
|0||0x000020||4609||PCM Sound Effect||
|-
|1||0x001221||4609||PCM Sound Effect||
|-
|2||0x002422||7759||PCM Sound Effect||
|-
|3||0x004271||7759||PCM Sound Effect||
|-
|4||0x0060C0||3735||PCM Sound Effect||
|-
|5||0x006F57||11387||PCM Sound Effect||
|-
|6||0x009BD2||6244||PCM Sound Effect||
|-
|7||0x00B436||12243||PCM Sound Effect||
|-
|8||0x00E409||7532||PCM Sound Effect||
|-
|9||0x010175||14259||PCM Sound Effect||
|-
|10||0x013928||6203||PCM Sound Effect||
|-
|11||0x015163||19699||PCM Sound Effect||
|-
|12||0x019E56||42261||PCM Sound Effect||
|-
|13||0x02436B||6169||PCM Sound Effect||
|-
|14||0x025B84||4318||PCM Sound Effect||
|-
|15||0x026C62||3702||PCM Sound Effect||
|-
|16||0x027AD8||7944||PCM Sound Effect||
|-
|17||0x0299E0||2167||PCM Sound Effect||
|-
|18||0x02A257||3006||PCM Sound Effect||
|-
|19||0x02AE15||4667||PCM Sound Effect||
|-
|20||0x02C050||7901||PCM Sound Effect||
|-
|21||0x02DF2D||5982||PCM Sound Effect||
|-
|22||0x02F68B||9396||PCM Sound Effect||
|-
|23||0x031B3F||156577||PCM Sound Effect||
|-
|24||0x057EE0||2715||PCM Sound Effect||
|-
|25||0x05897B||2608||PCM Sound Effect||
|-
|26||0x0593AB||3480||PCM Sound Effect||
|-
|27||0x05A143||6480||PCM Sound Effect||
|-
|28||0x05BA93||9771||PCM Sound Effect||
|-
|29||0x05E0BE||2284||PCM Sound Effect||
|-
|30||0x05E9AA||1435||PCM Sound Effect||
|-
|31||0x05EF45||39331||PCM Sound Effect||
|-
|32||0x0688E8||2177||PCM Sound Effect||
|-
|33||0x069169||12701||PCM Sound Effect||
|-
|34||0x06C306||1372||[[AdLib Timbre Bank Format]]||
|-
|35||0x06C862||1372||[[AdLib Timbre Bank Format]]||
|-
|36||0x06CDBE||1372||[[AdLib Timbre Bank Format]]||
|-
|37||0x06D31A||1372||[[AdLib Timbre Bank Format]]||
|-
|38||0x06D876||1372||[[AdLib Timbre Bank Format]]||
|-
|39||0x06DDD2||1372||[[AdLib Timbre Bank Format]]||
|-
|40||0x06E32E||1372||[[AdLib Timbre Bank Format]]||
|-
|41||0x06E88A||1372||[[AdLib Timbre Bank Format]]||
|-
|42||0x06EDE6||1372||[[AdLib Timbre Bank Format]]||
|-
|43||0x06F342||1372||[[AdLib Timbre Bank Format]]||
|-
|44||0x06F89E||1372||[[AdLib Timbre Bank Format]]||
|-
|45||0x06FDFA||1372||[[AdLib Timbre Bank Format]]||
|-
|46||0x070356||1372||[[AdLib Timbre Bank Format]]||
|-
|47||0x0708B2||1372||[[AdLib Timbre Bank Format]]||
|-
|48||0x070E0E||1372||[[AdLib Timbre Bank Format]]||
|-
|49||0x07136A||1372||[[AdLib Timbre Bank Format]]||
|-
|50||0x0718C6||1372||[[AdLib Timbre Bank Format]]||
|-
|51||0x071E22||14491||[[IMS Format]]||
|-
|52||0x0756BD||2179||[[IMS Format]]||
|-
|53||0x075F40||2416||[[IMS Format]]||
|-
|54||0x0768B0||438||[[IMS Format]]||
|-
|55||0x076A66||2836||[[IMS Format]]||
|-
|56||0x07757A||9280||[[IMS Format]]||
|-
|57||0x0799BA||4833||[[IMS Format]]||
|-
|58||0x07AC9B||4013||[[IMS Format]]||
|-
|59||0x07BC48||651||[[IMS Format]]||
|-
|60||0x07BED3||9877||[[IMS Format]]||
|-
|61||0x07E568||5364||[[IMS Format]]||
|-
|62||0x07FA5C||6790||[[IMS Format]]||
|-
|63||0x0814E2||8586||[[IMS Format]]||
|-
|64||0x08366C||7699||[[IMS Format]]||
|-
|65||0x08547F||15395||[[IMS Format]]||
|-
|66||0x0890A2||9218||[[IMS Format]]||
|-
|67||0x08B4A4||2843||[[IMS Format]]||
|-
|68||0x08BFBF||6790||[[IMS Format]]||
|-
|69||0x08DA45||15386||[[IMS Format]]||
|-
|70||0x09165F||3413||[[IMS Format]]||
|-
|71||0x0923B4||9087||[[IMS Format]]||
|-
|72||0x094733||7158||[[IMS Format]]||
|-
|73||0x096329||1372||[[AdLib Timbre Bank Format]]||
|-
|74||0x096885||1372||[[AdLib Timbre Bank Format]]||
|-
|75||0x096DE1||1372||[[AdLib Timbre Bank Format]]||
|-
|76||0x09733D||4837||[[IMS Format]]||
|-
|77||0x098622||1372||[[AdLib Timbre Bank Format]]||
|-
|78||0x098B7E||210650||unknown||
|}
PCM Sound Effects are raw 8-bit unsigned, but end with a 00 byte like [[VOC Format|VOC Files]].
There is one Timbre Bank (BNK) file for each IMS song. The first BNK belongs to the first IMS, the second BNK to the second IMS, etc.

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

ArtCraft Resource File Format

2016-03-05T08:46:03Z

ValleyBell: Initial version

{{Archive Infobox
| MaxFiles = Set by FAT length
| FAT = External
| Names = Yes
| Metadata = None
| Subdirectories = N
| Compressed = N
| Encrypted = N
| Hidden = N
| Games =
{{Game|Lychnis}}
}}
The '''ArtCraft Resource File Format''' is used by games of the Korean developer Artcraft.
The format itself stores no offsets and/or file names. Instead, file tables are stored in the game EXE files.

The format is very similar to [[SoftMax Resource File Format]], which is used in the later released game [[Sky & Rica]].

== File format ==

=== Signature ===

Lychnis uses the following signature:
{|class="wikitable"
! Data type!!Name!!Description
|-
|BYTE[0x20]||cSignature||"(C) ArtCraft Resource File" 0x1A 0x00*5
|}

=== FAT ===
The File Allocation Table is stored in the game executables.

[[Lychnis]] separately stores a list of file names (13-character strings, NULL-terminated), a list of UINT32LE file offsets and a list of UINT32LE file sizes. The lists are stored consecutively and in that order. The main executable <tt>LYCHNIS.EXE</tt> only contains a FAT for <tt>LYCHNIS2.RES</tt>. The resource file itself contains other executables, which also only contain the FAT for one of the two resource files.

{|class="wikitable"
!EXE File!!Resource file!!Number of files!!File names!!File offsets!!File sizes
|-
|LYCHNIS.EXE||lychnis2.res||114||0x00ECC0||0x00F28A||0x00F452
|-
|LYCH1||lychnis1.res||226||0x014CD0||0x01584A||0x015BD2
|-
|LYCH1P||lychnis1.res||226||0x012D32||0x0138AC||0x013C34
|-
|LYCH2||lychnis1.res||226||0x016DEE||0x017968||0x017CF0
|-
|LYCH2P||lychnis1.res||226||0x01661C||0x017196||0x01751E
|-
|LYCH3||lychnis1.res||226||0x015564||0x0160DE||0x016466
|-
|LYCH3P||lychnis1.res||226||0x014D72||0x0158EC||0x015C74
|-
|LYCH4||lychnis1.res||226||0x01454E||0x0150C8||0x015450
|-
|LYCH5||lychnis1.res||226||0x014D70||0x0158EA||0x015C72
|-
|LYCHB6||lychnis2.res||114||0x00C8F8||0x00CEC2||0x00D08A
|-
|BONUS||lychnis1.res||226||0x01281C||0x013396||0x01371E
|}
The file tables match between all executables that use the same resource file.

== List of files ==

The following table lists the contents of <tt>LYCHNIS2.RES</tt>.
Game executables can be renamed to .exe and executed directly. They read the configuration file <tt>LYCH.CFG</tt> to get the level to load.
{|class="wikitable"
!File #!!Offset!!Size!!Filename!!Format!!Notes
|-
|0||0x000020||1372||MAP.BNK||[[AdLib Timbre Bank Format]]||
|-
|1||0x00057C||1372||OPENING1.BNK||[[AdLib Timbre Bank Format]]||
|-
|2||0x000AD8||1372||OPENING2.BNK||[[AdLib Timbre Bank Format]]||
|-
|3||0x001034||1372||P-SELECT.BNK||[[AdLib Timbre Bank Format]]||
|-
|4||0x001590||1372||SHOP.BNK||[[AdLib Timbre Bank Format]]||
|-
|5||0x001AEC||1372||SLOT.BNK||[[AdLib Timbre Bank Format]]||
|-
|6||0x002048||1372||STAFFROL.BNK||[[AdLib Timbre Bank Format]]||
|-
|7||0x0025A4||1372||TITLE2.BNK||[[AdLib Timbre Bank Format]]||
|-
|8||0x002B00||15497||MAP.IMS||[[IMS Format]]||
|-
|9||0x006789||9028||OPENING1.IMS||[[IMS Format]]||
|-
|10||0x008ACD||5150||OPENING2.IMS||[[IMS Format]]||
|-
|11||0x009EEB||5184||P-SELECT.IMS||[[IMS Format]]||
|-
|12||0x00B32B||9532||SHOP.IMS||[[IMS Format]]||
|-
|13||0x00D867||9395||SLOT.IMS||[[IMS Format]]||
|-
|14||0x00FD1A||20001||STAFFROL.IMS||[[IMS Format]]||
|-
|15||0x014B3B||6596||TITLE2.IMS||[[IMS Format]]||
|-
|16||0x0164FF||12583||DRAGON.PCX||[[PCX Format]]||
|-
|17||0x019626||16566||ENDBACK.PCX||[[PCX Format]]||
|-
|18||0x01D6DC||7529||LOGO.PCX||[[PCX Format]]||
|-
|19||0x01F445||23289||MAP.PCX||[[PCX Format]]||
|-
|20||0x024F3E||19887||OPBACK.PCX||[[PCX Format]]||
|-
|21||0x029CED||14145||OPGONG.PCX||[[PCX Format]]||
|-
|22||0x02D42E||14393||OPIRIS.PCX||[[PCX Format]]||
|-
|23||0x030C67||7152||OPLYCH.PCX||[[PCX Format]]||
|-
|24||0x032857||26316||PLS.PCX||[[PCX Format]]||
|-
|25||0x038F23||36965||SHOP.PCX||[[PCX Format]]||
|-
|26||0x041F88||41849||SLOTBOX.PCX||[[PCX Format]]||
|-
|27||0x04C301||18666||STAFFB.PCX||[[PCX Format]]||
|-
|28||0x050BEB||10158||TITLE1.PCX||[[PCX Format]]||
|-
|29||0x053399||11358||TITLE2.PCX||[[PCX Format]]||
|-
|30||0x055FF7||768||DRAGON.PAL||6-bit [[VGA Palette]]||
|-
|31||0x0562F7||768||ENDING.PAL||6-bit [[VGA Palette]]||
|-
|32||0x0565F7||768||LOGO.PAL||6-bit [[VGA Palette]]||
|-
|33||0x0568F7||768||MAP.PAL||6-bit [[VGA Palette]]||
|-
|34||0x056BF7||768||OPEN.PAL||6-bit [[VGA Palette]]||
|-
|35||0x056EF7||768||PLS.PAL||6-bit [[VGA Palette]]||
|-
|36||0x0571F7||768||SHOP.PAL||6-bit [[VGA Palette]]||
|-
|37||0x0574F7||768||SLOTBOX.PAL||6-bit [[VGA Palette]]||
|-
|38||0x0577F7||768||STAFFROL.PAL||6-bit [[VGA Palette]]||
|-
|39||0x057AF7||768||TITLE.PAL||6-bit [[VGA Palette]]||
|-
|40||0x057DF7||33418||CAST.SPR||[[NeoTouken Sprite Format]]||
|-
|41||0x060081||1581||CURSOR.SPR||[[NeoTouken Sprite Format]]||
|-
|42||0x0606AE||8197||ENDING.SPR||[[NeoTouken Sprite Format]]||
|-
|43||0x0626B3||1179||EYE.SPR||[[NeoTouken Sprite Format]]||
|-
|44||0x062B4E||13740||IRISTITL.SPR||[[NeoTouken Sprite Format]]||
|-
|45||0x0660FA||9719||KA.SPR||[[NeoTouken Sprite Format]]||
|-
|46||0x0686F1||6067||LYCHTITL.SPR||[[NeoTouken Sprite Format]]||
|-
|47||0x069EA4||3165||MAPFACE.SPR||[[NeoTouken Sprite Format]]||
|-
|48||0x06AB01||1526||MAPMARK.SPR||[[NeoTouken Sprite Format]]||
|-
|49||0x06B0F7||26795||NARR1.SPR||[[NeoTouken Sprite Format]]||
|-
|50||0x0719A2||22665||NARR2.SPR||[[NeoTouken Sprite Format]]||
|-
|51||0x07722B||14806||NARR3.SPR||[[NeoTouken Sprite Format]]||
|-
|52||0x07AC01||18584||NARR4.SPR||[[NeoTouken Sprite Format]]||
|-
|53||0x07F499||2064||NUMBER.SPR||[[NeoTouken Sprite Format]]||
|-
|54||0x07FCA9||11032||OPTION.SPR||[[NeoTouken Sprite Format]]||
|-
|55||0x0827C1||13260||OX.SPR||[[NeoTouken Sprite Format]]||
|-
|56||0x085B8D||33587||PLS.SPR||[[NeoTouken Sprite Format]]||
|-
|57||0x08DEC0||5187||ROCK.SPR||[[NeoTouken Sprite Format]]||
|-
|58||0x08F303||16277||SAKI.SPR||[[NeoTouken Sprite Format]]||
|-
|59||0x093298||4160||SHOPCOIN.SPR||[[NeoTouken Sprite Format]]||
|-
|60||0x0942D8||15214||SHOPFACE.SPR||[[NeoTouken Sprite Format]]||
|-
|61||0x097E46||29187||SHOPMSG.SPR||[[NeoTouken Sprite Format]]||
|-
|62||0x09F049||25144||SLOT.SPR||[[NeoTouken Sprite Format]]||
|-
|63||0x0A5281||6476||SLOTNUM.SPR||[[NeoTouken Sprite Format]]||
|-
|64||0x0A6BCD||34564||STAFFROL.SPR||[[NeoTouken Sprite Format]]||
|-
|65||0x0AF2D1||2316||T1.SPR||[[NeoTouken Sprite Format]]||
|-
|66||0x0AFBDD||1204||T2.SPR||[[NeoTouken Sprite Format]]||
|-
|67||0x0B0091||8937||TIT.SPR||[[NeoTouken Sprite Format]]||
|-
|68||0x0B237A||3240||TIT2.SPR||[[NeoTouken Sprite Format]]||
|-
|69||0x0B3022||8825||TIT3.SPR||[[NeoTouken Sprite Format]]||
|-
|70||0x0B529B||26018||WEAPON.SPR||[[NeoTouken Sprite Format]]||
|-
|71||0x0BB83D||4471||CHOICE.VOC||[[VOC Format]]||
|-
|72||0x0BC9B4||59631||LOGO.VOC||[[VOC Format]]||
|-
|73||0x0CB2A3||1523||SELECT.VOC||[[VOC Format]]||
|-
|74||0x0CB896||83066||BONUS||Game Executable||Bonus Stages
|-
|75||0x0DFD10||92462||LYCH1||Game Executable||Stages 1-x
|-
|76||0x0F663E||100940||LYCH2||Game Executable||Stages 2-x
|-
|77||0x10F08A||94658||LYCH3||Game Executable||Stages 3-x
|-
|78||0x12624C||90540||LYCH4||Game Executable||Stages 4-x
|-
|79||0x13C3F8||92622||LYCH5||Game Executable||Stages 5-x
|-
|80||0x152DC6||83048||LYCH1P||Game Executable||Stage 1-3 Demo Play (with Lychnis)
|-
|81||0x16722E||99264||LYCH2P||Game Executable||Stage 2-2 Demo Play (with Iris)
|-
|82||0x17F5EE||92950||LYCH3P||Game Executable||Stage 3-2 Demo Play (with Lychnis)
|-
|83||0x196104||768||STAGE5.PAL||6-bit [[VGA Palette]]||
|-
|84||0x196404||23859||ST6BS.PCX||[[PCX Format]]||
|-
|85||0x19C137||9010||BING.SPR||[[NeoTouken Sprite Format]]||
|-
|86||0x19E469||15009||BOSSSLOT.SPR||[[NeoTouken Sprite Format]]||
|-
|87||0x1A1F0A||6154||EFF1.SPR||[[NeoTouken Sprite Format]]||
|-
|88||0x1A3714||2221||EFF2.SPR||[[NeoTouken Sprite Format]]||
|-
|89||0x1A3FC1||17653||INFO6.SPR||[[NeoTouken Sprite Format]]||
|-
|90||0x1A84B6||28250||IRIS1.SPR||[[NeoTouken Sprite Format]]||
|-
|91||0x1AF310||11760||ITEM15.SPR||[[NeoTouken Sprite Format]]||
|-
|92||0x1B2100||10307||ITEM2.SPR||[[NeoTouken Sprite Format]]||
|-
|93||0x1B4943||30352||LYCHNIS1.SPR||[[NeoTouken Sprite Format]]||
|-
|94||0x1BBFD3||8627||MOLEN31.SPR||[[NeoTouken Sprite Format]]||
|-
|95||0x1BE186||53463||NBOSS6.SPR||[[NeoTouken Sprite Format]]||
|-
|96||0x1CB25D||7707||NBOSS622.SPR||[[NeoTouken Sprite Format]]||
|-
|97||0x1CD078||4982||NUMBER2.SPR||[[NeoTouken Sprite Format]]||
|-
|98||0x1CE3EE||5204||PPANG.SPR||[[NeoTouken Sprite Format]]||
|-
|99||0x1CF842||1372||CLEARSTG.BNK||[[AdLib Timbre Bank Format]]||
|-
|100||0x1CFD9E||1372||FINALBOS.BNK||[[AdLib Timbre Bank Format]]||
|-
|101||0x1D02FA||1372||CLEAR.BNK||[[AdLib Timbre Bank Format]]||
|-
|102||0x1D0856||1372||GAMEOVER.BNK||[[AdLib Timbre Bank Format]]||
|-
|103||0x1D0DB2||1496||CLEAR.IMS||[[IMS Format]]||
|-
|104||0x1D138A||52550||FINALBOS.IMS||[[IMS Format]]||
|-
|105||0x1DE0D0||3733||GAMEOVER.IMS||[[IMS Format]]||
|-
|106||0x1DEF65||4161||ATTACK.VOC||[[VOC Format]]||
|-
|107||0x1DFFA6||9783||BOMB.VOC||[[VOC Format]]||
|-
|108||0x1E25DD||5621||DEFENCE.VOC||[[VOC Format]]||
|-
|109||0x1E3BD2||5379||ITEM2.VOC||[[VOC Format]]||
|-
|110||0x1E50D5||1869||MAGIC1.VOC||[[VOC Format]]||
|-
|111||0x1E5822||15426||NPAUSE.VOC||[[VOC Format]]||
|-
|112||0x1E9464||2251||SWORD1.VOC||[[VOC Format]]||
|-
|113||0x1E9D2F||56368||LYCHB6||Game Executable||Final Boss
|}

The following table lists the contents of <tt>LYCHNIS1.RES</tt>.
{|class="wikitable"
!File #!!Offset!!Size!!Filename!!Format!!Notes
|-
|0||0x000020||239||STEP.VOC||[[VOC Format]]||
|-
|1||0x00010F||1523||SELECT.VOC||[[VOC Format]]||
|-
|2||0x000702||1869||MAGIC1.VOC||[[VOC Format]]||
|-
|3||0x000E4F||2251||SWORD1.VOC||[[VOC Format]]||
|-
|4||0x00171A||2797||BOPEN.VOC||[[VOC Format]]||
|-
|5||0x002207||2968||ZZZ.VOC||[[VOC Format]]||
|-
|6||0x002D9F||3296||ITEM.VOC||[[VOC Format]]||
|-
|7||0x003A7F||4161||ATTACK.VOC||[[VOC Format]]||
|-
|8||0x004AC0||4352||BIRD.VOC||[[VOC Format]]||
|-
|9||0x005BC0||4471||CHOICE.VOC||[[VOC Format]]||
|-
|10||0x006D37||5379||ITEM2.VOC||[[VOC Format]]||
|-
|11||0x00823A||5503||XITEM.VOC||[[VOC Format]]||
|-
|12||0x0097B9||5621||DEFENCE.VOC||[[VOC Format]]||
|-
|13||0x00ADAE||7047||COIN.VOC||[[VOC Format]]||
|-
|14||0x00C935||7476||1UP.VOC||[[VOC Format]]||
|-
|15||0x00E669||9783||BOMB.VOC||[[VOC Format]]||
|-
|16||0x010CA0||15426||NPAUSE.VOC||[[VOC Format]]||
|-
|17||0x0148E2||4377||BALL.SPR||[[NeoTouken Sprite Format]]||
|-
|18||0x0159FB||2323||BAT1.SPR||[[NeoTouken Sprite Format]]||
|-
|19||0x01630E||2339||BAT2.SPR||[[NeoTouken Sprite Format]]||
|-
|20||0x016C31||12780||BEAR1.SPR||[[NeoTouken Sprite Format]]||
|-
|21||0x019E1D||6658||CACTUS1.SPR||[[NeoTouken Sprite Format]]||
|-
|22||0x01B81F||6676||CACTUS2.SPR||[[NeoTouken Sprite Format]]||
|-
|23||0x01D233||3348||CONCH1.SPR||[[NeoTouken Sprite Format]]||
|-
|24||0x01DF47||4095||CRAB1.SPR||[[NeoTouken Sprite Format]]||
|-
|25||0x01EF46||4113||CRAB2.SPR||[[NeoTouken Sprite Format]]||
|-
|26||0x01FF57||3518||CRAW1.SPR||[[NeoTouken Sprite Format]]||
|-
|27||0x020D15||3444||CRAW2.SPR||[[NeoTouken Sprite Format]]||
|-
|28||0x021A89||8730||EFF1.SPR||[[NeoTouken Sprite Format]]||
|-
|29||0x023CA3||3253||EFF2.SPR||[[NeoTouken Sprite Format]]||
|-
|30||0x024958||6296||FBIRD1.SPR||[[NeoTouken Sprite Format]]||
|-
|31||0x0261F0||6442||FBIRD2.SPR||[[NeoTouken Sprite Format]]||
|-
|32||0x027B1A||6965||FIRE1.SPR||[[NeoTouken Sprite Format]]||
|-
|33||0x02964F||6967||FIRE2.SPR||[[NeoTouken Sprite Format]]||
|-
|34||0x02B186||6202||FROG1.SPR||[[NeoTouken Sprite Format]]||
|-
|35||0x02C9C0||6168||FROG2.SPR||[[NeoTouken Sprite Format]]||
|-
|36||0x02E1D8||2755||GRASS1.SPR||[[NeoTouken Sprite Format]]||
|-
|37||0x02EC9B||2745||GRASS2.SPR||[[NeoTouken Sprite Format]]||
|-
|38||0x02F754||3130||HEDGEN1.SPR||[[NeoTouken Sprite Format]]||
|-
|39||0x03038E||2447||HEDGEN2.SPR||[[NeoTouken Sprite Format]]||
|-
|40||0x030D1D||3438||HORSE1.SPR||[[NeoTouken Sprite Format]]||
|-
|41||0x031A8B||3262||HORSE2.SPR||[[NeoTouken Sprite Format]]||
|-
|42||0x032749||5783||ICICLE1.SPR||[[NeoTouken Sprite Format]]||
|-
|43||0x033DE0||20713||INFO1.SPR||[[NeoTouken Sprite Format]]||
|-
|44||0x038EC9||21209||INFO2.SPR||[[NeoTouken Sprite Format]]||
|-
|45||0x03E1A2||20315||INFO3.SPR||[[NeoTouken Sprite Format]]||
|-
|46||0x0430FD||20430||INFO4.SPR||[[NeoTouken Sprite Format]]||
|-
|47||0x0480CB||20895||INFO5.SPR||[[NeoTouken Sprite Format]]||
|-
|48||0x04D26A||22068||INFOB.SPR||[[NeoTouken Sprite Format]]||
|-
|49||0x05289E||20525||IRIS1.SPR||[[NeoTouken Sprite Format]]||
|-
|50||0x0578CB||20275||IRIS2.SPR||[[NeoTouken Sprite Format]]||
|-
|51||0x05C7FE||11949||ITEM11.SPR||[[NeoTouken Sprite Format]]||
|-
|52||0x05F6AB||11868||ITEM12.SPR||[[NeoTouken Sprite Format]]||
|-
|53||0x062507||12084||ITEM13.SPR||[[NeoTouken Sprite Format]]||
|-
|54||0x06543B||11929||ITEM14.SPR||[[NeoTouken Sprite Format]]||
|-
|55||0x0682D4||11760||ITEM15.SPR||[[NeoTouken Sprite Format]]||
|-
|56||0x06B0C4||11718||ITEM1B.SPR||[[NeoTouken Sprite Format]]||
|-
|57||0x06DE8A||10307||ITEM2.SPR||[[NeoTouken Sprite Format]]||
|-
|58||0x0706CD||3614||LIEBOX1.SPR||[[NeoTouken Sprite Format]]||
|-
|59||0x0714EB||3500||LIEBOX2.SPR||[[NeoTouken Sprite Format]]||
|-
|60||0x072297||21479||LYCHNIS1.SPR||[[NeoTouken Sprite Format]]||
|-
|61||0x07767E||22061||LYCHNIS2.SPR||[[NeoTouken Sprite Format]]||
|-
|62||0x07CCAB||1437||MAGIC10.SPR||[[NeoTouken Sprite Format]]||
|-
|63||0x07D248||1476||MAGIC11.SPR||[[NeoTouken Sprite Format]]||
|-
|64||0x07D80C||1863||MAGIC12.SPR||[[NeoTouken Sprite Format]]||
|-
|65||0x07DF53||1941||MAGIC13.SPR||[[NeoTouken Sprite Format]]||
|-
|66||0x07E6E8||2524||MAGIC14.SPR||[[NeoTouken Sprite Format]]||
|-
|67||0x07F0C4||1575||MAGIC20.SPR||[[NeoTouken Sprite Format]]||
|-
|68||0x07F6EB||1542||MAGIC21.SPR||[[NeoTouken Sprite Format]]||
|-
|69||0x07FCF1||1919||MAGIC22.SPR||[[NeoTouken Sprite Format]]||
|-
|70||0x080470||2029||MAGIC23.SPR||[[NeoTouken Sprite Format]]||
|-
|71||0x080C5D||2714||MAGIC24.SPR||[[NeoTouken Sprite Format]]||
|-
|72||0x0816F7||3360||MOLEGHO1.SPR||[[NeoTouken Sprite Format]]||
|-
|73||0x082417||3400||MOLEGHO2.SPR||[[NeoTouken Sprite Format]]||
|-
|74||0x08315F||8224||MOLEN1.SPR||[[NeoTouken Sprite Format]]||
|-
|75||0x08517F||8496||MOLEN2.SPR||[[NeoTouken Sprite Format]]||
|-
|76||0x0872AF||8604||MOLEN21.SPR||[[NeoTouken Sprite Format]]||
|-
|77||0x08944B||9244||MOLEN22.SPR||[[NeoTouken Sprite Format]]||
|-
|78||0x08B867||8627||MOLEN31.SPR||[[NeoTouken Sprite Format]]||
|-
|79||0x08DA1A||8557||MOLEN32.SPR||[[NeoTouken Sprite Format]]||
|-
|80||0x08FB87||6175||MOLEN41.SPR||[[NeoTouken Sprite Format]]||
|-
|81||0x0913A6||6489||MOLEN42.SPR||[[NeoTouken Sprite Format]]||
|-
|82||0x092CFF||2274||MOUSE1.SPR||[[NeoTouken Sprite Format]]||
|-
|83||0x0935E1||2270||MOUSE2.SPR||[[NeoTouken Sprite Format]]||
|-
|84||0x093EBF||5558||MUSHN1.SPR||[[NeoTouken Sprite Format]]||
|-
|85||0x095475||5614||MUSHN2.SPR||[[NeoTouken Sprite Format]]||
|-
|86||0x096A63||4982||NUMBER2.SPR||[[NeoTouken Sprite Format]]||
|-
|87||0x097DD9||5579||OWLN1.SPR||[[NeoTouken Sprite Format]]||
|-
|88||0x0993A4||6360||PELICAN1.SPR||[[NeoTouken Sprite Format]]||
|-
|89||0x09AC7C||6556||PELICAN2.SPR||[[NeoTouken Sprite Format]]||
|-
|90||0x09C618||10056||PENGUIN1.SPR||[[NeoTouken Sprite Format]]||
|-
|91||0x09ED60||9734||PENGUIN2.SPR||[[NeoTouken Sprite Format]]||
|-
|92||0x0A1366||6266||PUMPKIN1.SPR||[[NeoTouken Sprite Format]]||
|-
|93||0x0A2BE0||6256||PUMPKIN2.SPR||[[NeoTouken Sprite Format]]||
|-
|94||0x0A4450||1678||RAFT.SPR||[[NeoTouken Sprite Format]]||
|-
|95||0x0A4ADE||2989||RMOLE1.SPR||[[NeoTouken Sprite Format]]||
|-
|96||0x0A568B||2903||RMOLE2.SPR||[[NeoTouken Sprite Format]]||
|-
|97||0x0A61E2||3275||SALAMAN1.SPR||[[NeoTouken Sprite Format]]||
|-
|98||0x0A6EAD||3297||SALAMAN2.SPR||[[NeoTouken Sprite Format]]||
|-
|99||0x0A7B8E||2948||SCOLP1.SPR||[[NeoTouken Sprite Format]]||
|-
|100||0x0A8712||2908||SCOLP2.SPR||[[NeoTouken Sprite Format]]||
|-
|101||0x0A926E||4394||SKULL1.SPR||[[NeoTouken Sprite Format]]||
|-
|102||0x0AA398||4394||SKULL2.SPR||[[NeoTouken Sprite Format]]||
|-
|103||0x0AB4C2||3896||SNAIL1.SPR||[[NeoTouken Sprite Format]]||
|-
|104||0x0AC3FA||3886||SNAIL2.SPR||[[NeoTouken Sprite Format]]||
|-
|105||0x0AD328||5517||SNOWMAN1.SPR||[[NeoTouken Sprite Format]]||
|-
|106||0x0AE8B5||5649||SNOWMAN2.SPR||[[NeoTouken Sprite Format]]||
|-
|107||0x0AFEC6||4955||SPEAR1.SPR||[[NeoTouken Sprite Format]]||
|-
|108||0x0B1221||4955||SPEAR2.SPR||[[NeoTouken Sprite Format]]||
|-
|109||0x0B257C||1824||SWORD10.SPR||[[NeoTouken Sprite Format]]||
|-
|110||0x0B2C9C||1807||SWORD11.SPR||[[NeoTouken Sprite Format]]||
|-
|111||0x0B33AB||2496||SWORD12.SPR||[[NeoTouken Sprite Format]]||
|-
|112||0x0B3D6B||2536||SWORD13.SPR||[[NeoTouken Sprite Format]]||
|-
|113||0x0B4753||2945||SWORD14.SPR||[[NeoTouken Sprite Format]]||
|-
|114||0x0B52D4||3126||SWORD15.SPR||[[NeoTouken Sprite Format]]||
|-
|115||0x0B5F0A||1952||SWORD20.SPR||[[NeoTouken Sprite Format]]||
|-
|116||0x0B66AA||1933||SWORD21.SPR||[[NeoTouken Sprite Format]]||
|-
|117||0x0B6E37||2660||SWORD22.SPR||[[NeoTouken Sprite Format]]||
|-
|118||0x0B789B||2682||SWORD23.SPR||[[NeoTouken Sprite Format]]||
|-
|119||0x0B8315||3065||SWORD24.SPR||[[NeoTouken Sprite Format]]||
|-
|120||0x0B8F0E||3212||SWORD25.SPR||[[NeoTouken Sprite Format]]||
|-
|121||0x0B9B9A||2062||TRAIN.SPR||[[NeoTouken Sprite Format]]||
|-
|122||0x0BA3A8||7496||TREE1.SPR||[[NeoTouken Sprite Format]]||
|-
|123||0x0BC0F0||7470||TREE2.SPR||[[NeoTouken Sprite Format]]||
|-
|124||0x0BDE1E||5645||TURTLE1.SPR||[[NeoTouken Sprite Format]]||
|-
|125||0x0BF42B||5791||TURTLE2.SPR||[[NeoTouken Sprite Format]]||
|-
|126||0x0C0ACA||2673||VOLCANO.SPR||[[NeoTouken Sprite Format]]||
|-
|127||0x0C153B||9991||ZOMBIE1.SPR||[[NeoTouken Sprite Format]]||
|-
|128||0x0C3C42||10135||ZOMBIE2.SPR||[[NeoTouken Sprite Format]]||
|-
|129||0x0C63D9||2555||BONUS1.SCR||[[ArtCraft Script Format]]??||
|-
|130||0x0C6DD4||2589||BONUS2.SCR||[[ArtCraft Script Format]]??||
|-
|131||0x0C77F1||542||BONUS3.SCR||[[ArtCraft Script Format]]??||
|-
|132||0x0C7A0F||534||BONUS4.SCR||[[ArtCraft Script Format]]??||
|-
|133||0x0C7C25||3342||ST1-1H.SCR||[[ArtCraft Script Format]]??||
|-
|134||0x0C8933||3505||ST1-1N.SCR||[[ArtCraft Script Format]]??||
|-
|135||0x0C96E4||3773||ST1-2H.SCR||[[ArtCraft Script Format]]??||
|-
|136||0x0CA5A1||3316||ST1-2N.SCR||[[ArtCraft Script Format]]??||
|-
|137||0x0CB295||4523||ST1-3H.SCR||[[ArtCraft Script Format]]??||
|-
|138||0x0CC440||4564||ST1-3N.SCR||[[ArtCraft Script Format]]??||
|-
|139||0x0CD614||4926||ST2-1H.SCR||[[ArtCraft Script Format]]??||
|-
|140||0x0CE952||4206||ST2-1N.SCR||[[ArtCraft Script Format]]??||
|-
|141||0x0CF9C0||4648||ST2-2H.SCR||[[ArtCraft Script Format]]??||
|-
|142||0x0D0BE8||4642||ST2-2N.SCR||[[ArtCraft Script Format]]??||
|-
|143||0x0D1E0A||4898||ST2-3H.SCR||[[ArtCraft Script Format]]??||
|-
|144||0x0D312C||4296||ST2-3N.SCR||[[ArtCraft Script Format]]??||
|-
|145||0x0D41F4||3100||ST3-1H.SCR||[[ArtCraft Script Format]]??||
|-
|146||0x0D4E10||2374||ST3-1N.SCR||[[ArtCraft Script Format]]??||
|-
|147||0x0D5756||4500||ST3-2H.SCR||[[ArtCraft Script Format]]??||
|-
|148||0x0D68EA||4572||ST3-2N.SCR||[[ArtCraft Script Format]]??||
|-
|149||0x0D7AC6||3676||ST3-3H.SCR||[[ArtCraft Script Format]]??||
|-
|150||0x0D8922||3619||ST3-3N.SCR||[[ArtCraft Script Format]]??||
|-
|151||0x0D9745||2999||ST4-1H.SCR||[[ArtCraft Script Format]]??||
|-
|152||0x0DA2FC||2658||ST4-1N.SCR||[[ArtCraft Script Format]]??||
|-
|153||0x0DAD5E||2305||ST4-2H.SCR||[[ArtCraft Script Format]]??||
|-
|154||0x0DB65F||1817||ST4-2N.SCR||[[ArtCraft Script Format]]??||
|-
|155||0x0DBD78||4032||ST4-3H.SCR||[[ArtCraft Script Format]]??||
|-
|156||0x0DCD38||4143||ST4-3N.SCR||[[ArtCraft Script Format]]??||
|-
|157||0x0DDD67||4087||ST5-1H.SCR||[[ArtCraft Script Format]]??||
|-
|158||0x0DED5E||3097||ST5-1N.SCR||[[ArtCraft Script Format]]??||
|-
|159||0x0DF977||1081||ST5-2H.SCR||[[ArtCraft Script Format]]??||
|-
|160||0x0DFDB0||1100||ST5-2N.SCR||[[ArtCraft Script Format]]??||
|-
|161||0x0E01FC||4854||ST5-3H.SCR||[[ArtCraft Script Format]]??||
|-
|162||0x0E14F2||5055||ST5-3N.SCR||[[ArtCraft Script Format]]??||
|-
|163||0x0E28B1||768||STAGE1.PAL||6-bit [[VGA Palette]]||
|-
|164||0x0E2BB1||768||STAGE2.PAL||6-bit [[VGA Palette]]||
|-
|165||0x0E2EB1||768||STAGE3.PAL||6-bit [[VGA Palette]]||
|-
|166||0x0E31B1||768||STAGE4.PAL||6-bit [[VGA Palette]]||
|-
|167||0x0E34B1||768||STAGE5.PAL||6-bit [[VGA Palette]]||
|-
|168||0x0E37B1||22465||BONUSSTG.IMS||[[IMS Format]]||
|-
|169||0x0E8F72||1496||CLEAR.IMS||[[IMS Format]]||
|-
|170||0x0E954A||3733||GAMEOVER.IMS||[[IMS Format]]||
|-
|171||0x0EA3DF||24704||LYCH0001.IMS||[[IMS Format]]||
|-
|172||0x0F045F||31708||LYCH0002.IMS||[[IMS Format]]||
|-
|173||0x0F803B||35483||LYCH0003.IMS||[[IMS Format]]||
|-
|174||0x100AD6||34069||LYCH0004.IMS||[[IMS Format]]||
|-
|175||0x108FEB||42622||LYCH0005.IMS||[[IMS Format]]||
|-
|176||0x113669||1372||BONUSSTG.BNK||[[AdLib Timbre Bank Format]]||
|-
|177||0x113BC5||1372||CLEAR.BNK||[[AdLib Timbre Bank Format]]||
|-
|178||0x114121||1372||GAMEOVER.BNK||[[AdLib Timbre Bank Format]]||
|-
|179||0x11467D||1372||LYCH0001.BNK||[[AdLib Timbre Bank Format]]||
|-
|180||0x114BD9||1372||LYCH0002.BNK||[[AdLib Timbre Bank Format]]||
|-
|181||0x115135||1372||LYCH0003.BNK||[[AdLib Timbre Bank Format]]||
|-
|182||0x115691||1372||LYCH0004.BNK||[[AdLib Timbre Bank Format]]||
|-
|183||0x115BED||1372||LYCH0005.BNK||[[AdLib Timbre Bank Format]]||
|-
|184||0x116149||24032||BONUS1.MAP||[[ArtCraft Level Map]]||
|-
|185||0x11BF29||8032||BONUS2.MAP||[[ArtCraft Level Map]]||
|-
|186||0x11DE89||4032||BONUS3.MAP||[[ArtCraft Level Map]]||
|-
|187||0x11EE49||20032||BONUS4.MAP||[[ArtCraft Level Map]]||
|-
|188||0x123C89||10272||STAGE1-1.MAP||[[ArtCraft Level Map]]||
|-
|189||0x1264A9||64032||STAGE1-2.MAP||[[ArtCraft Level Map]]||
|-
|190||0x135EC9||32432||STAGE1-3.MAP||[[ArtCraft Level Map]]||
|-
|191||0x13DD79||50032||STAGE2-1.MAP||[[ArtCraft Level Map]]||
|-
|192||0x14A0E9||64032||STAGE2-2.MAP||[[ArtCraft Level Map]]||
|-
|193||0x159B09||40032||STAGE2-3.MAP||[[ArtCraft Level Map]]||
|-
|194||0x163769||42032||STAGE3-1.MAP||[[ArtCraft Level Map]]||
|-
|195||0x16DB99||64032||STAGE3-2.MAP||[[ArtCraft Level Map]]||
|-
|196||0x17D5B9||64032||STAGE3-3.MAP||[[ArtCraft Level Map]]||
|-
|197||0x18CFD9||60032||STAGE4-1.MAP||[[ArtCraft Level Map]]||
|-
|198||0x19BA59||64032||STAGE4-2.MAP||[[ArtCraft Level Map]]||
|-
|199||0x1AB479||48032||STAGE4-3.MAP||[[ArtCraft Level Map]]||
|-
|200||0x1B7019||20032||STAGE5-1.MAP||[[ArtCraft Level Map]]||
|-
|201||0x1BBE59||36032||STAGE5-2.MAP||[[ArtCraft Level Map]]||
|-
|202||0x1C4B19||24032||STAGE5-3.MAP||[[ArtCraft Level Map]]||
|-
|203||0x1CA8F9||131102||BONUS1.DAT||[[ArtCraft Stage Tiles]]||
|-
|204||0x1EA917||131102||BONUS2.DAT||[[ArtCraft Stage Tiles]]||
|-
|205||0x20A935||131102||BONUS3.DAT||[[ArtCraft Stage Tiles]]||
|-
|206||0x22A953||131102||BONUS4.DAT||[[ArtCraft Stage Tiles]]||
|-
|207||0x24A971||131102||STAGE1-1.DAT||[[ArtCraft Stage Tiles]]||
|-
|208||0x26A98F||131102||STAGE1-2.DAT||[[ArtCraft Stage Tiles]]||
|-
|209||0x28A9AD||131102||STAGE1-3.DAT||[[ArtCraft Stage Tiles]]||
|-
|210||0x2AA9CB||131102||STAGE2-1.DAT||[[ArtCraft Stage Tiles]]||
|-
|211||0x2CA9E9||131102||STAGE2-2.DAT||[[ArtCraft Stage Tiles]]||
|-
|212||0x2EAA07||131102||STAGE2-3.DAT||[[ArtCraft Stage Tiles]]||
|-
|213||0x30AA25||131102||STAGE3-1.DAT||[[ArtCraft Stage Tiles]]||
|-
|214||0x32AA43||131102||STAGE3-2.DAT||[[ArtCraft Stage Tiles]]||
|-
|215||0x34AA61||131102||STAGE3-3.DAT||[[ArtCraft Stage Tiles]]||
|-
|216||0x36AA7F||131102||STAGE4-1.DAT||[[ArtCraft Stage Tiles]]||
|-
|217||0x38AA9D||131102||STAGE4-2.DAT||[[ArtCraft Stage Tiles]]||
|-
|218||0x3AAABB||131102||STAGE4-3.DAT||[[ArtCraft Stage Tiles]]||
|-
|219||0x3CAAD9||131102||STAGE5-1.DAT||[[ArtCraft Stage Tiles]]||
|-
|220||0x3EAAF7||131102||STAGE5-2.DAT||[[ArtCraft Stage Tiles]]||
|-
|221||0x40AB15||131102||STAGE5-3.DAT||[[ArtCraft Stage Tiles]]||
|-
|222||0x42AB33||15000||ST1-3N.MAC||Recorded keys for demo playback||
|-
|223||0x42E5CB||15000||ST2-2N.MAC||Recorded keys for demo playback||
|-
|224||0x432063||15000||ST3-2N.MAC||Recorded keys for demo playback||
|-
|225||0x435AFB||15000||ST4-1N.MAC||Recorded keys for demo playback||unused as there is no LYCH4P executable
|}

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

The Settlers II

2016-03-05T08:40:31Z

ValleyBell: add link for IFF XMidi files

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

The Settlers II is a game made by German BlueByte GmbH and it was released in 1996. Mission CD with a map editor was released a few months later and finally a more complete Gold Edition in 1997.

== Versions of the game ==

There are a few versions of the game available out in the wild in various European languages. Most easily you can find English and German versions.

{|
! Version
! Language
! Type
! Description
|-
| v0.15
| German
| Beta
| Die Siedler II: Erste demo (first demo)
|-
| v0.16
| German
| Beta
| Die Siedler II: Erste demo (first demo)
|-
| v1.01
| English
| Demo
| The Settler II: Veni Vidi Vici, demo including intro video (50 MiB)
|-
| v1.02
| English
| Demo
| The Settlers II: Veni Vici Vici, demo without intro video (3.5 MiB)
|-
| v1.02
| English
| CD release
| The Settlers II: Veni Vidi Vici
|-
| v1.51
| English
| Demo
| The Settlers II: Mission CD
|-
| v1.51
| English
| Demo
| The Settlers II: Gold Edition (has less files than Mission CD; has some files that do not exist in Mission CD)
|-
| v1.51
| English & German
| Update
| The Settlers II: Veni Vidi Vici / Die Siedler II: Veni Vidi Vici update to v1.51; no map editor
|-
| v1.51
| German
| Update
| Die Siedler II: Mission Disk; full version of map editor included
|}

Oddly enough there are no demo versions available in German language, they appear to be released in English only. In the other hand the early betas (or "first demos") are only available in German.

Biggest difference between versions can be found in the map file format: before v1.51 the map data files are divided to multiple files, while in v1.51 a new map file format was introduced to make sharing of map editor files easier.

{{BeginGameFileList}}
{{GameFile
| Name = *.wld or *.swd
| Format = [[WLD/SWD Format]]
| KnownFormat = Yes
| Desc = Map file / level
}}
{{GameFile
| Name = *.lst
| Format = Settlers II archive
| KnownFormat = Yes
| Desc = Palette, sprites, icons, fonts, sound
}}
{{GameFile
| Name = *.dat + *.idx (+ *.fnt)
| Format = Settlers II archive
| KnownFormat = Yes
| Desc = Sprites, icons, fonts
}}
{{GameFile
| Name = *.bob
| Format = Settlers II sprites
| KnownFormat = Yes
| Desc = Carriers and jobs; all moving characters of the game
}}
{{GameFile
| Name = *.rtx
| Format = Settlers II mission script
| KnownFormat = Yes
| Desc = Background music
}}
{{GameFile
| Name = *.eng or *.ger
| Format = Settlers II text
| KnownFormat = Yes
| Desc = Ingame strings
}}
{{GameFile
| Name = MASKS/MASKS000.DAT
| Format = Custom
| KnownFormat = No
| Desc = Very small file
}}
{{GameFile
| Name = *.rtx
| Format = Settlers II mission script
| KnownFormat = Yes
| Desc = Sets players, resources, available houses, scripting, story progression
}}
{{GameFile
| Name = SNG_00##.DAT
| Format = [[XMI Format|IFF XMidi]]
| KnownFormat = Yes
| Desc = Background music
}}
{{GameFile
| Name = CONTI###.DAT
| Format = Settlers II area index table
| KnownFormat = Yes
| Desc = Index for areas (land and water)
}}
{{GameFile
| Name = WORLD###.DAT
| Format = Settlers II map data
| KnownFormat = Yes
| Desc = Container for 14 blocks of various map data
}}
{{GameFile
| Name = GOU#.DAT or GOURAUD#.DAT
| Format = Custom
| KnownFormat = Yes
| Desc = Color brightness map for gouraud shading (256 x 256 UInt8 table)
}}
{{GameFile
| Name = *.bbm
| Format = [[LBM Format]] (compressed PBM)
| KnownFormat = Yes
| Desc = Terrain palettes
}}
{{GameFile
| Name = *.lbm
| Format = [[LBM Format]] (compressed PBM)
| KnownFormat = Yes
| Desc = Full screen graphics or textures
}}
{{GameFile
| Name = DIR.DAT
| Format = Custom
| KnownFormat = No
| Desc = Savegame, unknown
}}
{{GameFile
| Name = MISSION.DAT
| Format = Text file
| KnownFormat = Yes
| Desc = 1 for available mission, 0 for unavailable mission
}}
{{GameFile
| Name = RES.DAT
| Format = Custom
| KnownFormat = No
| Desc = Savegame, unknown
}}
{{GameFile
| Name = CNTRL###.DAT
| Format = Custom
| KnownFormat = No
| Desc = Savegame, unknown
}}
{{GameFile
| Name = COMPY###.DAT
| Format = Custom
| KnownFormat = No
| Desc = Savegame, unknown
}}
{{GameFile
| Name = DESKT###.DAT
| Format = Custom
| KnownFormat = No
| Desc = Savegame, unknown
}}
{{GameFile
| Name = MAILS###.DAT
| Format = Custom
| KnownFormat = No
| Desc = Savegame sent mail data
}}
{{GameFile
| Name = TRANS###.DAT
| Format = Custom
| KnownFormat = No
| Desc = Savegame transportation data
}}
{{EndGameFileList}}

== External links ==

- [http://settlers.net/ Settlers II.net] contains a lot of information, downloads and tools for the game.
- [http://siedler25.org/ Return to the Roots] is an open source remake with internet multiplayer and new features.

Shakii The Wolf

2016-03-05T08:39:32Z

ValleyBell: identify Family Production music format

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

[[Shakii]], full title Shakii the Wolf is a platformer made by the Korean company Family Production released in 1996. Shakii, the king of the kingdom Shake was chased out of his land by the evil king, Midnight Sword. Shakii must defeat Midnight Sword's minions and eventually the evil king himself to return peace to his land.

== File formats ==

{|class="wikitable"
! File name !! Description
|-
| <tt>*.cfg</tt>
|style="background: #FFCCCC;"| Game settings.
|-
| <tt>*.pal</tt>
|style="background: #CCFFCC;"| [[VGA_Palette | 6-bit VGA Palette]].
|-
| <tt>*.voc,*.eft</tt>
|style="background: #CCFFCC;"| RIFF Wave, [[VOC_Format | Creative Voice File]] and raw 8-bit unsigned, 8000 sample rate sounds.
|-
| <tt>*.bgf</tt>
|style="background: #FFCCCC;"| BGE font file.
|-
| <tt>*.raw</tt>
|style="background: #FFCCCC;"| Raw VGA graphics.
|-
| <tt>*.fnt</tt>
|style="background: #FFCCCC;"| Fonts.
|-
| <tt>*.bnk</tt>
|style="background: #CCFFCC;"| [[BNK Format (Ad Lib)]].
|-
| <tt>SH_*.kpf,S-STOUT.KPF</tt>
|style="background: #FFCCCC;"| [[IMS Format]]
|-
| <tt>ST*.KPF,</tt>
|style="background: #FFCCCC;"| KGE files.
|-
| <tt>STG#_*.KPF</tt>
|style="background: #FFCCCC;"| Stage Backgrounds.
|-
| <tt>*.bun,*.mjd</tt>
|style="background: #FFCCCC;"| Family Production Frame File.
|-
| <tt>*.fx4</tt>
|style="background: #FFCCCC;"| V4 Family Production Image Container.
|-
| <tt>*.fx5</tt>
|style="background: #FFCCCC;"| V5 Family Production Image Container.
|-
| <tt>*.map</tt>
|style="background: #FFCCCC;"| Shakii Map File.
|-
| <tt>*.tad</tt>
|style="background: #FFCCCC;"| Unknown, deals with stages.
|-
| <tt>*.mbd</tt>
|style="background: #FFCCCC;"| Unknown, deals with sprites.
|-
| <tt>*.ind</tt>
|style="background: #FFCCCC;"| Index file, see [[Pee and Gity]] for more information.
|-
| <tt>*.epd</tt>
|style="background: #FFCCCC;"| Unknown, deals with stages.
|-
| <tt>*.dac</tt>
|style="background: #FFCCCC;"| Scene data.
|-
| <tt>*.dat</tt>
|style="background: #FFCCCC;"| Raw storage of various filetypes.
|-
| <tt>FX3.dat</tt>
|style="background: #FFCCCC;"| Lists objects during game running.
|-
| <tt>*.id</tt>
|style="background: #FFCCCC;"| Identification file, contains only "family" and many zeros.
|}

==Interesting Facts==

- 16.EFT's header line is "Jeannie Blink" and is in fact that very sound from the TV series "I Dream of Jeannie". It is also a Mac FSSD despite this being a PC-DOS title.

[[Category:Sidescroller]]
[[Category:Family Production]]
[[Category:Game Intro Page]]

Pee and Gity

2016-03-05T08:38:20Z

ValleyBell: identify Family Production music format and add link for .voc files

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

Released in 1994, [[Pee And Gity]] is a brawler/beat em' up with cutesy anthropomorphic animals. The key characters being Pee the Squirrel, and Gity the Snake. The story, though in Korean, seems to be that Pee and Gity's house has been ransacked by evil forces and when they go to investigate they are ambushed by the forces of an evil being known as Herus who proceeds to transport them around.

There exists two versions of the game, Pee & Gity, and an updated version called Pee & Gity Special. The original featured more story elements but the Special version featured updated/added mechanics and some graphical tweaks.

== File formats ==

{|class="wikitable"
! File name !! Description
|-
| <tt>*.cfg</tt>
|style="background: #FFCCCC;"| Game settings.
|-
| <tt>*.hsv</tt>
|style="background: #CCFFCC;"| [[VGA_Palette | 6-bit VGA Palette]] Container, programs like FileSplitter can break them into 768-byte chunks and recombine.
|-
| <tt>*.dat</tt>
|style="background: #FFCCCC;"| Raw storage of various filetypes.
|-
| <tt>*.ind</tt>
|style="background: #FFCCCC;"| Index for raw storage *.dat files.
|-
| <tt>*.voc</tt>
|style="background: #CCFFCC;"| Header is "Saintcom Voice File" but otherwise they are just usual [[VOC Format|VOC Files]] with dummied out version and checksum
|-
| <tt>*.fx4</tt>
|style="background: #FFCCCC;"| V4 Family Production Image Container.
|-
| <tt>*.fsm</tt>
|style="background: #FFFFCC;"| [[ROL Format]] music.
|-
| <tt>*.fs2</tt>
|style="background: #CCFFCC;"| [[BNK Format (Ad Lib)]].
|-
| <tt>*.fbk</tt>
|style="background: #FFCCCC;"| "Background Data".
|-
| <tt>*.dac</tt>
|style="background: #FFCCCC;"| Scenes it seems in FX4 format.
|}

=== DAT and IND files ===

Each DAT container has an index of the same name. Indexes are extremely simple:

{|class="wikitable"
! Data type !! Name !! Description
|-
| [[UINT32LE]] || Pointer || States the end of previous file, start of next. 45 EF 00 00 = 0xEF45 or byte 61253 in DAT file.
|}

=== Pee and Gity Special ===

Some changes occured in the formats used between the two versions, the affected formats were:

{|class="wikitable"
! File name !! Description
|-
| <tt>*.voc</tt>
|style="background: #CCFFCC;"| RIFF Wave, [[VOC_Format | Creative Voice File]], "Saintcom Voice File", and raw.
|-
| <tt>*.f</tt>
|style="background: #FFCCCC;"| Compressed graphics for maps.
|-
| <tt>*.map</tt>
|style="background: #FFCCCC;"| Family Production Map.
|-
| <tt>*.dac</tt>
|style="background: #FFCCCC;"| Format changed, still seems to be scenes.
|-
| <tt>*.pcx</tt>
|style="background: #CCFFCC;"| [[PCX Format]].
|-
| <tt>*.fnt</tt>
|style="background: #FFCCCC;"| Font file.
|-
| <tt>*.fsm</tt>
|style="background: #FFCCCC;"| [[IMS Format]]
|}

=== Music Format Theory ===

The presence of AdLib Visual Composer ROL files in the first Pee & Gity suggests that the Family Production Music format is based on the ROL format. Makes sense for the time as IMF was born in the same manner but unlike IMF, the instrument synthesis bank (BNK) remained separate.

==Tools==

[http://cd.textfiles.com/knowledgemedia/CONVRTR/MSDOS/ROL2CMF/ ROL2CMF] this command-line tool can convert ROL files to [[CMF Format]] but with seeming quality loss.

I have made a VERY simple [http://pastebin.com/bJGbR00m QuickBMS] script for extracting most FX4 files from FX4.DAT. It doesn't snag the final file so far, however, but saves a lot of hex digging. The FX4s can be used in other Family Production titles but will naturally suffer color problems.

[[Category:Brawler]]
[[Category:Family Production]]
[[Category:Game Intro Page]]

Eol!

2016-03-05T08:30:13Z

ValleyBell: identify Family Production music files

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

[[Eol!]], full title Eol-ui Moheom (''Eol's Adventure'') is a platformer featuring a cutesy yellow creature named Eol, who one day, without warning, witnesses the world being split by an immense blast. This blast originating from a being known as Kare who too is of Eol's race.

The game features some of the best mechanics of Family Production, featuring legitimate challenge, hit-detection, and more well-scripted bosses and enemies. Visually it offers some of the best and most colorful VGA graphics among other titles in its genre.

== File formats ==

{|class="wikitable"
! File name !! Description
|-
| <tt>*.cfg</tt>
|style="background: #FFCCCC;"| Game settings.
|-
| <tt>*.pal</tt>
|style="background: #CCFFCC;"| [[VGA_Palette | 6-bit VGA Palette]].
|-
| <tt>*.emf</tt>
|style="background: #FFCCCC;"| [[IMS Format]]
|-
| <tt>EOL.BNK</tt>
|style="background: #CCFFCC;"| [[BNK Format (Ad Lib)]].
|-
| <tt>*.fx5</tt>
|style="background: #FFCCCC;"| Family Production FX5 File.
|-
| <tt>*.eft</tt>
|style="background: #CCFFCC;"| RIFF Wave, [[VOC_Format | Creative Voice File]] and raw 8-bit unsigned, 8000 sample rate sounds..
|-
| <tt>*.cap</tt>
|style="background: #FFCCCC;"| A form of actor behavior (AI) script.
|-
| <tt>*.fam</tt>
|style="background: #FFCCCC;"| Variable, but graphical and consists of scenes, including cutscenes.
|-
| <tt>*.mjd</tt>
|style="background: #FFCCCC;"| Unknown but seemingly deals with multi-part enemies.
|-
| <tt>*.mcd</tt>
|style="background: #FFCCCC;"| Unknown, but deals with maps.
|-
| <tt>*.img</tt>
|style="background: #FFCCCC;"| Seemingly Map Graphical Tiles.
|-
| <tt>*.efp</tt>
|style="background: #FFCCCC;"| Unknown, but deals with maps.
|-
| <tt>DEFAULT.EBF</tt>
|style="background: #FFCCCC;"| Unknown.
|-
| <tt>DEFAULT.HBF</tt>
|style="background: #FFCCCC;"| Unknown.
|-
| <tt>*.DPP</tt>
|style="background: #FFCCCC;"| Dragon Patch file, handled by DPP.EXE. Otherwise, unknown.
|}

==Notes==

- Object layout in stages are apparently hardcoded in the game executable EOL_GAME.EXE as no other file seemingly handle this function. However, overall level layout is handled by the MAP files. The setup thus far is unknown.

[[Category:Sidescroller]]
[[Category:Family Production]]
[[Category:Game Intro Page]]

IMS Format

2016-03-05T08:28:23Z

ValleyBell: Initial version

{{Music Infobox
| Type = MIDI
| Instruments = OPL
| NumChannels = 9 or 11
| NumTracks = 1
| NumPatterns = 1
| NumOrders = 0
| Tags = Title
| Games =
{{Game|Dragon Slayer: The Legend of Heroes}}
{{Game|Eol!}}
{{Game|Illusion Blaze}}
{{Game|Iron Blood}}
{{Game|Lychnis}}
{{Game|Olmang Jolmang Paradise}}
{{Game|Pee and Gity}}
{{Game|Reon-ui Moheom}}
{{Game|Shakii The Wolf}}
{{Game|Sky & Rica}}
{{Game|Vanslug: X Mission}}
}}
The '''IMS Format''' is an Ad Lib music format, based on the standard MIDI format. It is commonly seen in Korean DOS games.

The format is very similar to the [[AdLib MIDI Format]], but has an additional instrument table appended.
The instruments themselves are stored in a separate instrument bank in [[AdLib Timbre Bank Format]].

== File format ==

The file consists of a MIDI part that mostly matches the AdLib MIDI Format v1.0 and an instrument table that tells the player what instruments are to be loaded.

The instrument table is appended to the end of the MIDI data and has the following header:

{|class="wikitable"
! Data type !! Name !! Description
|-
| BYTE[2] || cSignature || 0x77 0x77 ("ww")
|-
| UINT16LE || numInstruments || Number of instruments used by the song
|}

This is followed by a list of instrument names, repeated <tt>numInstruments</tt> times:

{|class="wikitable"
! Data type !! Name !! Description
|-
| char[9] || name || Instrument name - must be NULL-terminated
|}

Each of the instrument names refers to the name of an instrument of an external instrument bank.

=== MIDI Commands ===
* Except for 8#, all commands match the [[AdLib MIDI Format]].
* As with usual MIDI files, the "running status" is supported for commands 8#..E#.

{| class="wikitable" |
! MIDI message !! Meaning !! Notes
|-
|8# nn vv||Note Retrigger||Stops the current note, then plays a new note if (vv > 0)
|-
|9# nn vv||Note On||Plays a note (vv > 0) or stops it (vv = 0)
|-
|A# vv||Volume Change||Changes the volume of the current note (also works after Note Off)
|-
|B# xx xx||ignored||MIDI Control Change
|-
|C# ii||Instrument Change||references an instrument from the instrument table
|-
|D# xx||ignored||MIDI Channel Aftertouch
|-
|E# ll mm||Pitch Bend||usual MIDI pitch bend, usually in the range of 1 semitone up/down
|-
|F0 7F 00 ii ff F7||Tempo Change||new Tempo = Initial Tempo * (ii + ff/0x80)
|-
|F0 xx ... xx F7||ignored||MIDI SysEx (without length)
|-
|F8||Delay Overflow||causes a delay of 240 ticks
|-
|FC||Song End||stops the song or restarts it from the beginning if looping is enabled
|}

== Tools ==

{{BeginFileFormatTools|Type=audio}}
{{FileFormatTool
| Name = [http://ulisu.egloos.com/1236597 OCPlay]
| Platform = DOS
| canPlay = Yes
| canCreate = No
| canModify = No
| canExport = No
| canImport = No
| editHidden = No
| editMetadata = No
| notes =
}}
{{EndFileFormatTools}}

== Credits ==

This file format was reverse engineered by [[User:ValleyBell|Valley Bell]] from IMS songs used by [[Family Production]] games and by disassembling [[Lychnis]]. 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!)

Also thanks to MaliceX for helping to identify games that use IMS songs.