Pikmin Technical Knowledge Base - User contributions [en]

Creating cave music

2024-10-02T14:12:25Z

Waffles:

Randomly generating cave music in Pikmin 2 needs to have two files: a .bms (sequence) file, and a .cnd (conductor) file.

The BMS file type is a sequenced music format used in many games. For the cave music in Pikmin 2 however, it is specially-formatted. It mainly contains many short snippets of musical information to be randomized.

The CND files are the actual "songs"; they take specific groups of snippets from a BMS file, and endlessly puzzle-piece them together to form a coherent piece of music.

This guide will function as a walkthrough for creating your own randomly sequencing cave song. Basic understanding of how [https://youtube.com/watch?v=QPFWzSlg-78 cave music works] and [[Creating Interactive BMS Files|standard interactive music]] is recommended before starting. Most of the editing will be done in hexadecimal.

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be generating a lot of tiny BMS files, to turn them into "gestures".
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

Additionally, studying the existing cave songs on your own and how those exploit the conductor system in interesting ways will help you come up with ideas for your own custom cave music.

== Overview of file functions ==
Here are some infographics that you can reference at any time. These show all the functions of a CND file, and all the contents of a BMS file.
<gallery mode="packed-hover" widths=250px heights=250px>
File:CND_functions.png|Conductor file functions.
File:BMS_functions.png|How information is stored in a BMS file.
</gallery>

== Setting up your BMS file ==
Before you begin, set your byte grouping to "3", so every 3 bytes is visually separated by a space. This will make it easier to see stuff. 
Starting with a completely blank BMS file, begin by pasting the following:
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600
</source>
Every cave music BMS begins with this same information, and will go mostly untouched.
 
 

== Gesture set list ==
Exactly right after <code>34C600</code> will be a list of every gesture set's location in the BMS. Each entry is the gesture set's hexadecimal location (offset), and each entry in the sequence begins with "<code>00</code>". <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0001B0 0001BF 0001CE 0001D4 0001DA 0001E9 0001F8 0001FE 000204 00020A FFFFFF</code> 
Gesture set "0" will be at offset <code>0x1B0</code>, gesture set "1" will be at offset <code>0x1BF</code>, gesture set "2" will be at <code>0x1CE</code>, and so on. There are a total of 10 gesture sets listed in the above sequence.
 
Until we create our gesture sets, let's use <code>00AAAA</code> as placeholders so we can easily find and get back to this section later on. You can have as many gesture sets as you like; we'll create 16 entries for this tutorial. You may insert this into your BMS: 
<code>00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF</code> 
 
Our BMS should now currently look like this: 
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000
</source>
You can also add an entire row of padding/zeros after this. You can do this for each section, to better visually separate them.
 

== Timing ruleset list ==
This is another sequence of offsets. These just point to the location of a "[[#Inserting_timetables|timetable]]", which will be located at the end of our BMS file. <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0005AB 0005AB 0005AF 0005C1 0005AB 0005AB 0005C1 0005C1 0005C1 0005C1 FFFFFF</code> 
Timing ruleset "0" will use the timetable at <code>0x5AB</code>, timing ruleset "1" will also use the timetable at <code>0x5AB</code>, timing ruleset "2" will use the timetable at <code>0x5AF</code>, and so on. There are a total of 10 timing rulesets listed in the above sequence.
 
Let's use <code>00BBBB</code> as placeholders again, and create 16 of them. Insert this anywhere into your BMS: 
<code>00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB FFFFFF</code> 
 

== Gesture set contents ==
A ''gesture set'' is a group of many gestures. 
Here, we list each gesture set's contents (which will be... the locations of the gestures!). Each gesture set begins before with <code>00</code> and ends with <code>FFFFFF</code>. 
Here is an example of how the gesture set list should be formatted: 
<code>000210 00022A 000258 000281 FFFFFF 0002B4 0002D9 000303 000331 FFFFFF 000355 FFFFFF 000361 FFFFFF 0003A8 0003C2 0003F0 000419 FFFFFF 00044C 000471 00049B 0004C9 FFFFFF 0004ED FFFFFF 000543 FFFFFF 000580 FFFFFF 00059E FFFFFF</code> 
There are 10 gesture sets listed above. The first gesture set has 4 gestures, located at <code>0x210</code>, <code>0x22A</code>, <code>0x258</code>, and <code>0x281</code>. You can have any amount of gestures in a gesture set; even 1 is fine.
 
You can paste the following placeholder information for now: 
<code>00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC FFFFFF</code> 
It might be a good idea to leave a decent amount of zeros after this list; this one will expand a lot as gestures and gesture sets are added to it.
 

== How is your BMS looking? ==
If you have been copy-pasting everything correctly, your BMS will look something like this:
<gallery mode="packed-hover" widths=300px heights=300px>
File:BMS_file_progress_1.png|Orange is "gesture set list", yellow is "timing ruleset list", and blue is "gesture set contents"
</gallery>
Once again, you can add as much padding between each section as you want, it will work fine.

== Creating gestures ==
First, you should sketch out your song idea in your DAW, and then cut your song into tiny blocks. These blocks will be your song's individual gestures. You should also consider dragging these blocks around in various arrangements to make sure they sound good in any order. 
Once you are ready, have them nicely organized and ready to be exported into individual MIDI files:
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_Pro_gestures.png|A Logic Pro project with a bunch of short blocks of music. Each block will be a "gesture".
</gallery>
For some reason, imported BMS files play 4 times as slow in cave songs. So if you import these gestures as is, they will play 4 times as slow. 
Before you export your gestures, you need to modify your gestures to run ''4 times as fast''. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each block.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>

== Inserting gestures ==
Gestures use same the note/music information as standard BMS songs. 

You should have converted all your MIDIs into BMS files. Open up one of your converted BMS files, and look for the first note/pitch value. If you used [[Pikmin 2 custom music|flaaffy]], this will most likely be somewhere after <code>0x1B</code>, <code>0x1C</code>, or <code>0x1D</code>. The note's pitch value will often be followed by a <code>01</code>, then the velocity value. Copy this note, all the way to the end of the sequence, which should be <code>FF</code>.
<gallery mode="packed-hover" widths=600px>
File:Copy_pasting_BMS_info.png|The value "2D" here is the hex value of a certain pitch, and the very first note of the sequence. Copy this, all the way to "FF".
</gallery>
To add your gesture, start it with <code>C40000015D</code>, then paste in what you copied. Each gesture should end with that <code>FF</code>. Add as many gestures as you please!
<gallery mode="packed-hover" widths=400px heights=400px>
File:BMS_file_progress_2.png|The purple lines indicate where a gesture starts.
</gallery>

== Inserting timetables ==
So, how do we choose how often gestures will play? Will a gesture play every beat? Every 1/2 a beat? You will need to add a timetable for that!
A timetable is a sequence that dictates when gestures should play. A timetable ends with <code>FFFF</code>. You can make a timetable as complex as you like. Some examples of timetables you can use are: 
* <code>0780 FFFF</code> Play a gesture every 16 beats. 
* <code>03C0 FFFF</code> Play a gesture every 8 beats. 
* <code>01E0 FFFF</code> Play a gesture every 4 beats. 
* <code>03C0 03C0 03C0 01E0 01E0 01E0 01E0 03C0 FFFF</code> This sequence will play a gesture every 8 beats (3x), play a gesture every 4 beats (4x), then play a gesture for 8 beats (1x), in that order. 
* <code>00F0 FFFF</code> Play a gesture every 1/2 note (every 2 beats). 
* <code>0078 FFFF</code> Play a gesture every 1/4 note (every beat). 
* <code>003C FFFF</code> Play a gesture every 1/8th note. 
* <code>001E FFFF</code> Play a gesture every 1/16th note. 
* <code>003C 0078 001E FFFF</code> This sequence will play a gesture for an 1/8th note, play a gesture for a 1/4 note, then play a gesture for a 1/16th note, in that order. 
Considering that <code>001E</code> (30 in decimal) is a 1/16th note, you can create any specific timing you want. Just add another 30 to the value for each additional sixteenth note in length. 
For example, Soil 1's enemy mix piano plays a gesture every three sixteenth notes. That would be 90 in decimal, and its timetable would look like <code>005A FFFF</code>. 
You can insert your timetables anywhere at the end of your BMS.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_3.png|Each timetable has a pink box around it.
</gallery>

== Filling in info ==
Once you have your gestures and timetables inserted, go back and fill in those <code>00AAAA</code>, <code>00BBBB</code>, <code>00CCCC</code> placeholders with the locations of your gesture sets, timetables, and gestures you want to use. Remember that gesture sets begin with the <code>00</code>.

Also in the very beginning of your BMS, make sure the value at <code>0x6</code> has the location of where your gesture set list begins (this one will probably be fine), and the value at <code>0x14</code> has the location of where your timing ruleset list begins.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_4.png|Put the location of where the "timing ruleset list" begins here.
</gallery>

== Filling in the conductor file ==
<gallery mode="packed-hover" widths=500px heights=500px>
File:CND_functions.png|Conductor file functions.
</gallery>
In your song's associated conductor file, try to stretch out the window so that the instrument names are all in the same column if you can, like in the image above. 
Each line represents one track. You give each track a instrument (program), and what gesture set and timing ruleset to use. 
The CND infographic above does a good job explaining all the functions, but they'll be explained again down here. 

In the top left corner are three important values:
* The first value is the swing time. <code>1E</code> is 1/16th swing, while <code>3C</code> is 1/8th swing. If your song is below 100bpm, you might want to use <code>1E</code>. If its faster, try <code>3C</code> instead.
* The second value is the tempo, in hex.
* The third value is how many tracks there will be, in hex.

Each column explained:
* A: Initial delay. How many beats until this track starts running. In the vanilla game, you can notice how some song's melodies do not immediately begin playing upon the start of the level. This is useful for that; ease the listener into the music.
* B/Q: If set to 1, all gestures will be delayed by an 1/8th note.
* C: Text string. You can make this say whatever you like. Useful for keeping track of what you want each track to be, like "Lead", "Trumpet", "MelodyA"/"MelodyB", "Bass", or "Drums"
* D: Track copy. Select a previous track # to copy the gestures from. If the track its copying plays "gesture 3" from its gesture set, this track will also play its "gesture 3". Often used for treasure mix instruments. You can have them use different gesture sets if you like.
* E: Echo strength.
* F: If set to 1, the values in this track's timetable will always be played in order, in a loop. If set to 0, it will randomly select values from its timetable, thus, allowing you to randomize when gestures play.
* G: Bank number.
* H: Program number. For a list of all programs in the default game and the wScenes that support them, view [[Pikmin 2 custom_music/available instruments|this page]].
* I: Gesture set, select the set # you want to use from the BMS.
* J: Timing ruleset, select the set # you want to use from the BMS.
* K: How many gestures this track will play, before playing "silent gestures". Linked to below. These function as a sort of on/off cycle.
* L: How many "silent gestures" this track will play, before playing normal gestures. Linked to above. These function as a sort of on/off cycle.
* M: If notes are being transposed down (see below), this is set to FF. But this column doesn't actually do anything, so you don't need to edit this.
* N: Transpose all notes played by this track. To transpose up, use values 1-127. To transpose down, use the sign 2 compliment (values 128-255).
* O: Volume.
* P: Stereo panning.
 
Some ideas/considerations:
* You can use the on/off cycle feature (column K and L) to make your melodic instrument "take a break" every once in a while. You can have it play 4 gestures, but then be silent for 2.
* If your timing ruleset is strict (as in, the timings for when gestures occur is always consistent), something fun to try is to have the melody be a back-and-forth between two different instruments. Set the initial delay for the second instrument to be longer than the first one, and then cleverly use the on/off cycle to have the instruments take turns sounding a gesture. This is done for the melody in the Bulblax Kingdom and Frontier Cavern for example.
* If you are using the "track copy" feature (column D), you can have the primary instrument play a melody, and have this instrument always play chords that perfectly match that melody.

== Mapping the tracks ==
With all that done, don't forget to edit the song's [[Trackmap parameters|trackMap]]! Edit your song in the trackMap files in either <code>/user/Totaka</code> or <code>/user/Wakai</code>, and set how many instruments will be in each mix. It goes in order from: Main Mix, Task (event), Treasure (otakara), Enemy near (kehai), Combat mix, and Spiderwort mix (ground). Although you cannot find Spiderworts underground, you will have to sacrifice at least one track for that mix. You cannot set any of the mixes to have 0 tracks in them.

== Bonus: Filenames for brand new CND files ==
If you are adding a brand new CND file instead of replacing an existing one, the prefix will determine which BMS is loaded, and which wScene. Try not to add special characters to filenames, aside from underscores. 

In order to load the correct BMS file, the CND must start with the name of the BMS file.
* "caveconc.cnd", "caveconc_458435.cnd", "caveconc_Waffles.cnd", and "caveconc_Waffles_Song_2.cnd" will all load caveconc.bms. 
* "caverelax.cnd", "caverelax_Gmajor.cnd", and "caverelax_mamuta_dinner.cnd" will all load caverelax.bms. 
* "new_09_4.cnd", "new_09_4000.cnd", and "new_09_portal_PotaTOS.cnd" will load new_09.bms. 

For cavesoil, caveconc, and cavemetal only, the game also checks for an additional "_00", "_05", and "_10" right after the prefix, for the purpose of loading one of three different wScenes. You must include it if you want the correct wScene to load. For example, caveconc_05 loads wScene 31, so if you want your custom song to also load wScene 31, acceptable names include "caveconc_05_WAFFLES.cnd", "caveconc_05_52_46356.cnd", or "caveconc_05_super_boss.cnd". 

After adding your new CND file, be sure to add it to its respective trackMap file.

== Bonus: Adding new content to a vanilla BMS file ==
Adding new hex data in the middle of a file will shift all the offsets that come after it, causing your BMS to jump to the wrong locations, and likely cause a crash if vanilla songs are loaded. 
In order to add new content in addition to what's already in the BMS:
* Find and copy the gesture set list and the timing ruleset list, and paste them at the end of the file. (Separate them with lots of zeros so you have lots more space to add content to these lists)
* Change <code>0x6</code> and <code>0x14</code> to point to your new gesture set list and timing ruleset list. These two values tell the game where the lists are.
The game should now use these brand new lists, instead of the original instances that occur earlier in the file. Since they still contain all the locations of the vanilla gesture sets/timetables from above in the same order, the existing CND songs won't be affected and will continue to function, but now you can expand upon these lists with brand new entries now that you've made the space for them. All new gestures, gesture sets and timetables can be added further down the file.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Editing_vanilla_BMS_file.png|The new gesture set list and timing ruleset list we want to use will be at the bottom.
</gallery>

== Bonus: Adding gesture cutoffs in timetables ==
An intentional compositional choice in some songs is to cutoff gestures while they're in the middle of playing. The most common way this is done is to quickly trigger another gesture; if the last gesture has not finished playing, it will stop playing that gesture and begin playing the new one. It's also possible to add "empty" gestures to gesture sets (like <code>C40000015DFF</code>, a gesture which ends immediately and plays nothing), so you can randomly interrupt gestures in your song with silence, or have there be a chance to play nothing. 
However, if you wish to interrupt gestures in your song at specified times without the randomness, there is a special function in timetables for doing this. In the vanilla game, this is used for the trumpet in [https://www.youtube.com/watch?v=qOhmS1YLpF8 Fire]. The trumpet plays two interrupted gestures, then plays a third gesture in full. Below is the timetable for this trumpet: 
<code>0078 8168 81E0 00F0 80F0 81E0 0780 FFFF</code> 
The trumpet will:
* <code>0078</code> play a gesture for 1 beat
* <code>8168</code> cutoff after this 1 beat
* <code>81E0</code> extend the silence for another 4 beats
* <code>00F0</code> play a gesture for 2 beats
* <code>80F0</code> cutoff after these 2 beats
* <code>81E0</code> extend the silence for another 4 beats
* <code>0780</code> play a gesture for 16 beats. 
In order to put a "cutoff" in your timetable:
* Start with how long you want your "playing" gesture to play for, before it gets cutoff. I want the the first gesture to last for one beat (four 1/16th notes), so I'll put <code>0078</code>. Remember that every "30" in decimal is equivalent to a sixteenth note.
* Immediately next in the sequence will be a value that indicates when the cutoff begins. Calculate the difference between "81E0" and the previous value you had just inserted. 81E0 - 0078 = 8168 (in decimal, 33248 - 120 = 33128). I will put <code>8168</code> next in my sequence.
My sequence is now <code>0078 8168 FFFF</code>; this will play a gesture normally for 1 beat, but then immediately cut it off after that 1 beat. 
Putting an additional <code>81E0</code> in the sequence right after will extend the silence for another 4 beats if you so desire. You can keep putting <code>81E0</code> right after several times in a row if you want silence to last extra long until the next gesture plays.

[[Category:Pikmin 2]]

Pikmin 2 directory tree

2024-07-31T18:12:28Z

Waffles:

{{DISPLAYTITLE:''Pikmin 2'' directory tree}}
This article lists all folders and noteworthy files in ''Pikmin 2'', and recommended tools for viewing or modifying them. 
Yellow rows are folders, and red rows are unused files or folders with no effect on the game.

{{todo|Add links for everything.}}

{| class="wikitable sortable"
! Path || Details || Recommended Tool
|-
| style="background-color:#ffffcc"|<code>AudioRes/</code> || style="background-color:#ffffcc"|[[Jsystem#JAudio|JAudio]] resources. Contains data for music, instruments, and sound effects. || Pikmin 2 Sound Modding Toolkit
|-
| style="background-color:#ffffcc"|<code>AudioRes/Banks</code> || style="background-color:#ffffcc"|[[AW file|<code>.AW</code> wave scene files]]. Contain audio samples of instruments and sound effects for the instrument programs. || Pikmin 2 Sound Modding Toolkit
|-
| style="background-color:#ffd1d1"|<code>AudioRes/BgmList.txt</code> || style="background-color:#ffd1d1"|Early list of [[Pikmin 2 BMS file list|sequences]] and volume settings. The real <code>BgmList.txt</code> is in Totaka's folder. || Notepad++
|-
| style="background-color:#ffffcc"|<code>AudioRes/Conductor.arc/</code> || style="background-color:#ffffcc"|[[Pikmin 2 CND file list|<code>.CND</code> conductor files]]. Creates music for caves. || Hex Editor
|-
| style="background-color:#ffffcc"|<code>AudioRes/Key.arc/</code> || style="background-color:#ffffcc"|<code>.BAS</code> files, which link SoundIDs to enemy animations. || Hex Editor
|-
| style="background-color:#ffd1d1"|<code>AudioRes/Key.arc/enemy.prj</code> || style="background-color:#ffd1d1"|Leftover project information about the <code>.BAS</code> files.
|-
| <code>AudioRes/PSound.aaf</code> || [[AFF file|<code>.AAF</code> audio archive file]]. Integral file that contains information about all the available sound effects, waves, instrument banks + programs, and music. || Pikmin 2 Sound Modding Toolkit
|-
| <code>AudioRes/PSound.asn</code> || <code>.ASN</code> audio sound names. Contains a list of all SoundIDs, which reference a sequence from <code>se.bms</code>. || asn2csv
|-
| style="background-color:#ffffcc"|<code>AudioRes/Seqs/Seq.arc/</code> || style="background-color:#ffffcc"|[[Pikmin 2 BMS file list|<code>.BMS</code> binary music sequences]]. Contains sequenced music (akin to MIDI files). || flaaffy or JAIMaker
|-
| <code>AudioRes/Seqs/Seq.arc/se.bms</code> || Special <code>.BMS</code> file containing all sound effect sequences in the game. || p2setoolkit, flaaffy or JAIMaker
|-
| style="background-color:#ffffcc"|<code>AudioRes/Stream/</code> || style="background-color:#ffffcc"|[[AST file list|<code>.AST</code> audio streams.]] Contains streamed music (akin to WAV or MP3 files). || JATAST
|-
| style="background-color:#ffd1d1"|<code>banner/</code> || style="background-color:#ffd1d1"|Contains three different Gamecube banner images for ''Pikmin 2''. This folder is unused; depending on the region, one of these was copied and placed into the root directory as <code>opening.bnr</code> || pyisotools
|-
| style="background-color:#ffffcc"|<code>enemy/</code> || style="background-color:#ffffcc"|Enemy data. Also includes plants, hazards, and misc. objects.
|-
| style="background-color:#ffffcc"|<code>enemy/common/enemyCommon.szs/</code> || style="background-color:#ffffcc"|Models of the rocks used in petrification. || FinModelUtility, SuperBMD, RiiStudio
|-
| style="background-color:#ffffcc"|<code>enemy/data/</code> || style="background-color:#ffffcc"|Enemy models, <code>.BCA</code> animations, and textures. || FinModelUtility, SuperBMD (animations), RiiStudio, GameCube File Tools (for <code>.BTI</code> textures).
|-
| style="background-color:#ffffcc"|<code>enemy/parm/enemyParms.szs/</code> || style="background-color:#ffffcc"|[[Pikmin 2 enemy parameters|Parameters for enemy HP, damage, move speed, collisions, animations, and ultra-bitter petrification models]]. || Notepad++, Pikmin 2 Enemy Collision Tree Blender Addon, Pikmin 2 Enemy Bitter/Stoneinfo Blender Addon
|-
| <code>enemy/parm/enemyResList.txt</code> || List of enemy resource file paths. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>*gameConfig.ini</code> || style="background-color:#ffd1d1"|These were likely game configuration settings that changed how the game was compiled, to create special versions of ''Pikmin 2''. || Notepad++
|-
| style="background-color:#ffffcc"|<code>memoryCard/memoryCardHeader.szs/</code> || style="background-color:#ffffcc"|Memory card menu icons and banner images. || Wiimms Image Tool + Hex Editor
|-
| <code>message/font_*.szs/pikmin2main.bfn</code> || Font data and textures. || bfntoolkit + GameCube File Tools
|-
| <code>message/mesRes_*.szs/pikmin2.bmc</code> || Data for font coloring. || Hex Editor
|-
| <code>message/mesRes_*.szs/pikmin2.bmg</code> || [[BMG file]], all text strings and dialog in the game. || pikminBMG
|-
| style="background-color:#ffffcc"|<code>new_screen/</code> || style="background-color:#ffffcc"|[[BLO file|<code>.BLO</code>files]]: HUDs, interfaces, and menus, with all their resources like graphics and animations. || pyblo2-gui
|-
| <code>opening.bnr</code> || Gamecube banner image. || pyisotools
|-
| <code>pikmin2*P.MAP</code> || Symbol map. Text file that lists where every function and piece of data in the game's code is located and its name, and is used in-game by the crash handler for debugging purposes. The symbol map in retail versions of the game is unreadable. || Notepad++
|-
| style="background-color:#ffffcc"|<code>thp/</code> || style="background-color:#ffffcc"|[[THP file|<code>.THP</code>files]]. Pre-rendered videos. The .ini files control when text strings are loaded on top of the videos. || wiiflowthpvideoconverter, Notepad++ (for .ini files)
|-
| style="background-color:#ffd1d1"|<code>timeStamp*.txt</code> || style="background-color:#ffd1d1"|Build dates. "J", "P", and "U" likely represent the Japanese, PAL, and US versions. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/</code> || style="background-color:#ffffcc"|Masamichi Abe's folder, who was a director for the game.
|-
| style="background-color:#ffffcc"|<code>user/Abe/cave/</code> || style="background-color:#ffffcc"|[[Pikmin 2 cave lighting files|Lighting files for caves]]. || Drought Ender's Cave Creator, Notepad++
|-
| <code>user/Abe/item/barrelParms.txt</code> || Clog health parameter. || Notepad++
|-
| <code>user/Abe/item/bridgeParms.txt</code> || Bridge health parameter. || Notepad++
|-
| <code>user/Abe/item/fountainParms.txt</code> || Challenge Mode geyser health parameter. || Notepad++
|-
| <code>user/Abe/item/plantParms.txt</code> || Burgeoning Spiderwort parameters. || Notepad++
|-
| <code>user/Abe/item/rockParms.txt</code> || Burgeoning Spiderwort mold parameters. || Notepad++
|-
| <code>user/Abe/item/TreasureParms.txt</code> || Buried treasure health parameters. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/map/</code> || style="background-color:#ffffcc"|Routes/pathing, [[Pikmin 2 area generator file|object generation]], [[Pikmin 2 map lighting files|day cycle lighting]], and settings for aboveground areas (including the test map and Piklopedia areas). || Gen & Route Editor, Notepad++ (for .txt files/.ini lighting)
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/</code> || style="background-color:#ffffcc"|All treasure models and their <code>.BCK</code> carrying animations, as well as parameters for all carriable objects. || FinModelUtility, SuperBMD (animations), RiiStudio, Notepad++ (for collision/parameters)
|-
| style="background-color:#ffd1d1"|<code>user/Abe/Pellet/*/carcass_config.txt</code> || style="background-color:#ffd1d1"|Unused enemy carcass parameters. The real parameters are in <code>/user/Abe/Pellet/*/pelletlist_*.szs</code>. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Abe/Pellet/*/item_config.txt</code> || style="background-color:#ffd1d1"|Unused Exploration Kit treasure parameters. The real parameters are in <code>/user/Abe/Pellet/*/pelletlist_*.szs</code>. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/item_texts.szs</code> || style="background-color:#ffffcc"|Collision parameters for the Exploration Kit treasures, and their animation file paths. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Abe/Pellet/*/otakara_config.txt</code> || style="background-color:#ffd1d1"|Unused treasure parameters. The real parameters are in <code>/user/Abe/Pellet/*/pelletlist_*.szs</code>. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/otakara_texts.szs</code> || style="background-color:#ffffcc"|Collision parameters for the treasures, and their animation file paths. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/pellet.szs/</code> || style="background-color:#ffffcc"|All numbered pellet models, their <code>.BCK</code> carrying animations, and <code>.BRK</code> files that control their color. || FinModelUtility, SuperBMD (animations), RiiStudio
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/pellet_texts.szs/</code> || style="background-color:#ffffcc"|Collision parameters for the numbered pellets, and their animation file paths. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/pelletlist_*.szs</code> || style="background-color:#ffffcc"|Carryable object parameters, including enemy carcasses, Spiderwort berries, treasures, Exploration Kit treasures, and the numbered pellets. Includes carry weights, pokos earned, seeds earned, and the depth treasures are buried. || Notepad++
|-
| <code>user/Abe/piki/naviParms.txt</code> || [[NaviParms|Leader parameters]], like speed and attack power. || Notepad++
|-
| <code>user/Abe/piki/pikiParms.txt</code> || [[PikiParms|Pikmin parameters]], like speed and attack power. || Notepad++
|-
| <code>user/Abe/stages.txt</code> || List of aboveground areas and parameters. || Notepad++
|-
| <code>user/Abe/time/time.ini</code> || Day cycle parameters, controlling the length of the day and the related events that occur. || Notepad++
|-
| <code>user/Abe/vs/stages.txt</code> || [[2-Player Battle stage parameters|List of 2-Player Battle stages and parameters]]. || Notepad++
|-
| <code>user/Abe/vs/vs_X_*.txt</code> || [[Cave fixed layout|Pre-determined layouts]] for the 2-Player Battle stages, listing the cave units they use and their locations. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/</code> || style="background-color:#ffffcc"|Yasushi Ebisawa's folder, who programmed the particle effects and title screen.
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/card_e_reader/</code> || style="background-color:#ffffcc"|<code>.DWN</code> files for the three e-Reader Pikmin minigames.
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/effect/</code> || style="background-color:#ffffcc"|<code>.JPC</code> [[Jsystem#JParticle|JParticle]] archive files. All of the game's used particles and effects. || jpc_conv, GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Ebisawa/testdata/</code> || style="background-color:#ffd1d1"|Unused menu files, e-Reader files, and title screen things. || FinModelUtility, SuperBMD (animations), RiiStudio, GameCube File Tools (for <code>.BTI</code> textures)
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/title/</code> || style="background-color:#ffffcc"|Models and <code>.BCK</code> animations for the title screen and enemies/Pikmin on it. || FinModelUtility, SuperBMD (animations), RiiStudio
|-
| <code>user/Ebisawa/title/title.szs/param/param_pikmin.txt</code> || [[Pikmin 2 title screen|Title screen Pikmin parameters]]. || Notepad++
|-
| <code>user/Ebisawa/title/title.szs/param/param_title.txt</code> || [[Pikmin 2 title screen|Title screen parameters]]. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Kando/</code> || style="background-color:#ffffcc"|Yuji Kando's folder, who programmed the Pikmin and other various systems.
|-
| <code>user/Kando/aiConstants.txt</code> || Some parameters for constants: gravity, Spiderwort berries needed to create 1 spray, amount needed to repay the debt, and "camera angle" (the Y-axis rotation for when you enter a stage). || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Kando/bridge/</code> || style="background-color:#ffd1d1"|Unused bridge models. || FinModelUtility, SuperBMD, RiiStudio, obj2grid (for the <code>.BIN</code> collision files), GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Kando/develop/</code> || style="background-color:#ffd1d1"|Leftover development tool resources, seemingly for a map editor, route/path manager, a [[Jsystem#J2DGraph|2D graphic]] tester, and animation tester, among other things. || FinModelUtility, SuperBMD, RiiStudio, GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Kando/effect/game.jpc</code> || style="background-color:#ffd1d1"|Unused <code>.JPC</code> [[Jsystem#JParticle|JParticle]] archive file with a bunch of particle effects. || jpc_conv, GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/effect/modeleffect.szs</code> || style="background-color:#ffffcc"|Onion beam model and <code>.BRK</code>/<code>.BTK</code> animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/maps/</code> || style="background-color:#ffffcc"|Models for aboveground/piklopedia areas, [[Pikmin 2 waterboxes|waterboxes]], and [https://www.pikminwiki.com/Pikmin_2_cave_generation#Backgrounds cave vrboxes]. || FinModelUtility, SuperBMD, RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffd1d1"|<code>user/Kando/mizu.bti</code> || style="background-color:#ffd1d1"|Unused texture. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/objects/</code> || style="background-color:#ffffcc"|Models and animations for some objects: clog, bridge, seesaw blocks, cave entrances, gates, nectar, geyser, Burgeoning Spiderwort mold, Pikmin head, Burgeoning Spiderwort, nectar rock, Ujadani, and nectar weed. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/onyon/</code> || style="background-color:#ffffcc"|Onion models and animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/piki/</code> || style="background-color:#ffffcc"|Model and animations for Pikmin, leaders, and the cursor + reticle. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/pod*/</code> || style="background-color:#ffffcc"|Research Pod model and animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffd1d1"|<code>user/Kando/resulttex/</code> || style="background-color:#ffd1d1"|Unused old Treasure Hoard icons, likely for cave/day end results. || GameCube File Tools
|-
| <code>user/Kando/texCaster/arc.szs/tex.bti</code> || Texture that is placed below treasures that spawn in caves. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/ufo*/</code> || style="background-color:#ffffcc"|Hocotate Ship model and animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/vstex/</code> || style="background-color:#ffffcc"|2-Player Battle Roulette icons and other minor HUD textures. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/zukan/</code> || style="background-color:#ffffcc"|Slightly simpler copy of the unused test map, with its own generation and lighting settings. || Gen & Route Editor (for routes/finding coords for [[Pikmin 2 waterboxes|waterboxes]]), Notepad++ (for .txt files/.ini lighting)
|-
|-
| style="background-color:#ffffcc"|<code>user/Koono/</code> || style="background-color:#ffffcc"|Hiroyuki Kono (Koono)'s folder, who programmed menus for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Koono/mail_icon.szs</code> || style="background-color:#ffffcc"|Space mail icons. || GameCube File Tools
|-
| <code>user/Koono/mail_table.szs/mail_table.bin</code> || IDs from the <code>.BMG</code> that correspond to each piece of [[mail]]. || Hex Editor
|-
| style="background-color:#ffffcc"|<code>user/Matoba/</code> || style="background-color:#ffffcc"|Taku Matoba's folder, who designed caves for ''Pikmin 2''.
|-
| <code>user/Matoba/challenge/stages.txt</code> || [[Pikmin 2 Challenge Mode settings|List of Challenge Mode stages and parameters]]. || Notepad++
|-
| <code>user/Matoba/challenge/kfes-stages.txt</code> || List of Challenge Mode stages and parameters, when the game is in KFes mode. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Matoba/resulttex/</code> || style="background-color:#ffffcc"|Treasure icons used in the Treasure Hoard and cave/day end results. || GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Morimura/</code> || style="background-color:#ffd1d1"|Naoya Morimura's leftover folder, who programmed the more complicated enemies for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Mukki/</code> || style="background-color:#ffffcc"|Yutaka Hiramuki's folder, who designed caves for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Mukki/mapunits/arc/</code> || style="background-color:#ffffcc"|[[Cave unit generation|Cave unit assets and data]]. Contains models, routes/pathfinding, and [[Pikmin 2 waterboxes|waterboxes]]. || FinModelUtility, SuperBMD, RiiStudio, obj2grid (for the <code>.BIN</code> collision files, Gen & Route Editor (for routes/finding coords for waterboxes), Notepad++ (for waterboxes), GameCube File Tools (for radar texture)
|-
| style="background-color:#ffffcc"|<code>user/Mukki/caveinfo/</code> || style="background-color:#ffffcc"|[[Cave generation parameters|Cave generation files]]. || Drought Ender's Cave Creator, Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Mukki/units/</code> || style="background-color:#ffffcc"|[[Cave unit definition file|Cave unit definition files]]. || Drought Ender's Cave Creator, Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Mukki/movie/</code> || style="background-color:#ffffcc"|[[STB file|<code>.STB</code> files]]. In-game cutscenes. || pikmin2-stb
|-
| style="background-color:#ffffcc"|<code>user/Nishimura/</code> || style="background-color:#ffffcc"|Katsushito Nishimura's folder, who programmed enemies and the levels for ''Pikmin 2''.
|-
| <code>user/Nishimura/Camera/caveCameraParms.txt</code> || [[Pikmin 2 camera parameters|Camera parameters]] when in caves. || Notepad++
|-
| <code>user/Nishimura/Camera/groundCameraParms.txt</code> || [[Pikmin 2 camera parameters|Camera parameters]] when aboveground. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/引きカメラcameraParms.txt</code> || style="background-color:#ffd1d1"|Unused [[Pikmin 2 camera parameters|camera parameters]].
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/撮影cameraParms.txt</code> || style="background-color:#ffd1d1"|Unused [[Pikmin 2 camera parameters|camera parameters]].
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/本物 groundCameraParms.txt</code> || style="background-color:#ffd1d1"|Unused [[Pikmin 2 camera parameters|camera parameters]].
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/本物caveCameraParms.txt</code> || style="background-color:#ffd1d1"|Unused [[Pikmin 2 camera parameters|camera parameters]].
|-
| <code>user/Nishimura/Rumble/rumbleData.txt</code> || Controller rumble time and power parameters. || Notepad++
|-
| <code>user/Nishimura/Rumble/rumbleParms.txt</code> || Controller rumble modifier for distant objects. || Notepad++
|-
| <code>user/Nishimura/Shadow/shadowParms.txt</code> || Shadow parameters. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Ogawa/</code> || style="background-color:#ffd1d1"|Yuzuru Ogawa's leftover folder, who programmed menus for ''Pikmin 2'',
|-
| style="background-color:#ffffcc"|<code>user/Totaka/</code> || style="background-color:#ffffcc"|Kazumi Totaka's folder, who directed the sound design and created some music and sound effects for ''Pikmin 2''.
|-
| <code>user/Totaka/BgmList.txt</code> || List of all [[Pikmin 2 BMS file list|<code>.BMS</code> sequences]] and volume settings for each. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Totaka/BgmList_BgmTest.txt</code> || style="background-color:#ffd1d1"|List of all [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] in the game, with a leftover developer comment about compiling cave songs. || Notepad++
|-
| <code>user/Totaka/BgmList_Forest.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for Awakening Wood cave sublevels. || Notepad++
|-
| <code>user/Totaka/BgmList_Last.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for Wistful Wild cave sublevels. || Notepad++
|-
| <code>user/Totaka/BgmList_Tutorial.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for Valley of Repose cave sublevels. || Notepad++
|-
| <code>user/Totaka/BgmList_Yakushima.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for Perplexing Pool cave sublevels. || Notepad++
|-
| <code>user/Totaka/ChallengeBgmList.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for all Challenge Mode cave sublevels. || Notepad++
|-
| <code>user/Totaka/StreamList.txt</code> || List of all [[AST file list|streams]], their ID, and volume settings. || Notepad++
|-
| <code>user/Totaka/trackMap_Cond_T.txt</code> || [[Trackmap parameters|Track mappings]] that apply to caveconc and new_XX [[Pikmin 2 CND file list|<code>.CND</code> conductor files]]. || Notepad++
|-
| <code>user/Totaka/trackMap_Seq_T.txt</code> || [[Trackmap parameters|Track mappings]] that apply to caveglass and caverelax [[Pikmin 2 BMS file list|<code>.BMS</code> sequences]]. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Wakai/</code> || style="background-color:#ffffcc"|Hajime Wakai's folder, who wrote music for ''Pikmin 2''.
|-
| <code>user/Wakai/trackMap_Cond_W.txt</code> || [[Trackmap parameters|Track mappings]] that apply to cavemetal and cavesoil [[Pikmin 2 CND file list|<code>.CND</code> conductor files]]. || Notepad++
|-
| <code>user/Wakai/trackMap_Seq_W.txt</code> || [[Trackmap parameters|Track mappings]] that apply to a few of Hajime Wakai's [[Pikmin 2 BMS file list|<code>.BMS</code> sequences]].|| Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/</code> || style="background-color:#ffffcc"|Yoshikazu Yamashita's folder, who did system programming and programmed most of the enemies for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/arc/</code> || style="background-color:#ffffcc"|Boot screen textures. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/enemytex/</code> || style="background-color:#ffffcc"|Piklopedia icons. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/zukan/</code> || style="background-color:#ffffcc"|Piklopedia enemy appearance parameters and day cycle lighting parameters. || Notepad++
|-

[[Category:Pikmin 2]]
[[Category:Directory trees]]

Pikmin 2 directory tree

2024-05-10T09:18:46Z

Waffles:

{{DISPLAYTITLE:''Pikmin 2'' directory tree}}
This article lists all folders and noteworthy files in ''Pikmin 2'', and recommended tools for viewing or modifying them. 
Yellow rows are folders, and red rows are unused files or folders with no effect on the game.

{{todo|Add links for everything.}}

{| class="wikitable sortable"
! Path || Details || Recommended Tool
|-
| style="background-color:#ffffcc"|<code>AudioRes/</code> || style="background-color:#ffffcc"|[[Jsystem#JAudio|JAudio]] resources. Contains data for music, instruments, and sound effects. || Pikmin 2 Sound Modding Toolkit
|-
| style="background-color:#ffffcc"|<code>AudioRes/Banks</code> || style="background-color:#ffffcc"|[[AW file|<code>.AW</code> wave scene files]]. Contain audio samples of instruments and sound effects for the instrument programs. || Pikmin 2 Sound Modding Toolkit
|-
| style="background-color:#ffd1d1"|<code>AudioRes/BgmList.txt</code> || style="background-color:#ffd1d1"|Early list of [[Pikmin 2 BMS file list|sequences]] and volume settings. The real <code>BgmList.txt</code> is in Totaka's folder. || Notepad++
|-
| style="background-color:#ffffcc"|<code>AudioRes/Conductor.arc/</code> || style="background-color:#ffffcc"|[[Pikmin 2 CND file list|<code>.CND</code> conductor files]]. Creates music for caves. || Hex Editor
|-
| style="background-color:#ffffcc"|<code>AudioRes/Key.arc/</code> || style="background-color:#ffffcc"|<code>.BAS</code> files, which link SoundIDs to enemy animations. || Hex Editor
|-
| style="background-color:#ffd1d1"|<code>AudioRes/Key.arc/enemy.prj</code> || style="background-color:#ffd1d1"|Leftover project information about the <code>.BAS</code> files.
|-
| <code>AudioRes/PSound.aaf</code> || [[AFF file|<code>.AAF</code> audio archive file]]. Integral file that contains information about all the available sound effects, waves, instrument banks + programs, and music. || Pikmin 2 Sound Modding Toolkit
|-
| <code>AudioRes/PSound.asn</code> || <code>.ASN</code> audio sound names. Contains a list of all SoundIDs, which reference a sequence from <code>se.bms</code>. || asn2csv
|-
| style="background-color:#ffffcc"|<code>AudioRes/Seqs/Seq.arc/</code> || style="background-color:#ffffcc"|[[Pikmin 2 BMS file list|<code>.BMS</code> binary music sequences]]. Contains sequenced music (akin to MIDI files). || flaaffy or JAIMaker
|-
| <code>AudioRes/Seqs/Seq.arc/se.bms</code> || Special <code>.BMS</code> file containing all sound effect sequences in the game. || p2setoolkit, flaaffy or JAIMaker
|-
| style="background-color:#ffffcc"|<code>AudioRes/Stream/</code> || style="background-color:#ffffcc"|[[AST file list|<code>.AST</code> audio streams.]] Contains streamed music (akin to WAV or MP3 files). || JATAST
|-
| style="background-color:#ffd1d1"|<code>banner/</code> || style="background-color:#ffd1d1"|Contains three different Gamecube banner images for ''Pikmin 2''. This folder is unused; depending on the region, one of these was copied and placed into the root directory as <code>opening.bnr</code> || pyisotools
|-
| style="background-color:#ffffcc"|<code>enemy/</code> || style="background-color:#ffffcc"|Enemy data. Also includes plants, hazards, and misc. objects.
|-
| style="background-color:#ffffcc"|<code>enemy/common/enemyCommon.szs/</code> || style="background-color:#ffffcc"|Models of the rocks used in petrification. || FinModelUtility, SuperBMD, RiiStudio
|-
| style="background-color:#ffffcc"|<code>enemy/data/</code> || style="background-color:#ffffcc"|Enemy models, <code>.BCA</code> animations, and textures. || FinModelUtility, SuperBMD (animations), RiiStudio, GameCube File Tools (for <code>.BTI</code> textures).
|-
| style="background-color:#ffffcc"|<code>enemy/parm/enemyParms.szs/</code> || style="background-color:#ffffcc"|[[Pikmin 2 enemy parameters|Parameters for enemy HP, damage, move speed, collisions, animations, and ultra-bitter petrification models]]. || Notepad++, Pikmin 2 Enemy Collision Tree Blender Addon, Pikmin 2 Enemy Bitter/Stoneinfo Blender Addon
|-
| <code>enemy/parm/enemyResList.txt</code> || List of enemy resource file paths. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>*gameConfig.ini</code> || style="background-color:#ffd1d1"|These were likely game configuration settings that changed how the game was compiled, to create special versions of ''Pikmin 2''. || Notepad++
|-
| style="background-color:#ffffcc"|<code>memoryCard/memoryCardHeader.szs/</code> || style="background-color:#ffffcc"|Memory card menu icons and banner images. || Wiimms Image Tool + Hex Editor
|-
| <code>message/font_*.szs/pikmin2main.bfn</code> || Font data and textures. || bfntoolkit + GameCube File Tools
|-
| <code>message/mesRes_*.szs/pikmin2.bmc</code> || Data for font coloring. || Hex Editor
|-
| <code>message/mesRes_*.szs/pikmin2.bmg</code> || [[BMG file]], all text strings and dialog in the game. || pikminBMG
|-
| style="background-color:#ffffcc"|<code>new_screen/</code> || style="background-color:#ffffcc"|[[BLO file|<code>.BLO</code>files]]: HUDs, interfaces, and menus, with all their resources like graphics and animations. || pyblo2-gui
|-
| <code>opening.bnr</code> || Gamecube banner image. || pyisotools
|-
| <code>pikmin2*P.MAP</code> || Symbol map. Text file that lists where every function and piece of data in the game's code is located and its name, and is used in-game by the crash handler for debugging purposes. The symbol map in retail versions of the game is unreadable. || Notepad++
|-
| style="background-color:#ffffcc"|<code>thp/</code> || style="background-color:#ffffcc"|[[THP file|<code>.THP</code>files]]. Pre-rendered videos. The .ini files control when text strings are loaded on top of the videos. || wiiflowthpvideoconverter, Notepad++ (for .ini files)
|-
| style="background-color:#ffd1d1"|<code>timeStamp*.txt</code> || style="background-color:#ffd1d1"|Build dates. "J", "P", and "U" likely represent the Japanese, PAL, and US versions. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/</code> || style="background-color:#ffffcc"|Masamichi Abe's folder, who was a director for the game.
|-
| style="background-color:#ffffcc"|<code>user/Abe/cave/</code> || style="background-color:#ffffcc"|[[Pikmin 2 cave lighting files|Lighting files for caves]]. || Drought Ender's Cave Creator, Notepad++
|-
| <code>user/Abe/item/barrelParms.txt</code> || Clog health parameter. || Notepad++
|-
| <code>user/Abe/item/bridgeParms.txt</code> || Bridge health parameter. || Notepad++
|-
| <code>user/Abe/item/fountainParms.txt</code> || Challenge Mode geyser health parameter. || Notepad++
|-
| <code>user/Abe/item/plantParms.txt</code> || Burgeoning Spiderwort parameters. || Notepad++
|-
| <code>user/Abe/item/rockParms.txt</code> || Burgeoning Spiderwort mold parameters. || Notepad++
|-
| <code>user/Abe/item/TreasureParms.txt</code> || Buried treasure health parameters. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/map/</code> || style="background-color:#ffffcc"|Routes/pathing, [[Pikmin 2 area generator file|object generation]], [[Pikmin 2 map lighting files|day cycle lighting]], and settings for aboveground areas (including the test map and Piklopedia areas). || Gen & Route Editor, Notepad++ (for .txt files/.ini lighting)
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/</code> || style="background-color:#ffffcc"|All treasure models and their <code>.BCK</code> carrying animations, as well as parameters for all carriable objects. || FinModelUtility, SuperBMD (animations), RiiStudio, Notepad++ (for collision/parameters)
|-
| style="background-color:#ffd1d1"|<code>user/Abe/Pellet/*/carcass_config.txt</code> || style="background-color:#ffd1d1"|Unused enemy carcass parameters. The real parameters are in <code>/user/Abe/Pellet/*/pelletlist_*.szs</code>. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Abe/Pellet/*/item_config.txt</code> || style="background-color:#ffd1d1"|Unused Exploration Kit treasure parameters. The real parameters are in <code>/user/Abe/Pellet/*/pelletlist_*.szs</code>. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/item_texts.szs</code> || style="background-color:#ffffcc"|Collision parameters for the Exploration Kit treasures, and their animation file paths. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Abe/Pellet/*/otakara_config.txt</code> || style="background-color:#ffd1d1"|Unused treasure parameters. The real parameters are in <code>/user/Abe/Pellet/*/pelletlist_*.szs</code>. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/otakara_texts.szs</code> || style="background-color:#ffffcc"|Collision parameters for the treasures, and their animation file paths. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/pellet.szs/</code> || style="background-color:#ffffcc"|All numbered pellet models, their <code>.BCK</code> carrying animations, and <code>.BRK</code> files that control their color. || FinModelUtility, SuperBMD (animations), RiiStudio
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/pellet_texts.szs/</code> || style="background-color:#ffffcc"|Collision parameters for the numbered pellets, and their animation file paths. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/pelletlist_*.szs</code> || style="background-color:#ffffcc"|Carryable object parameters, including enemy carcasses, Spiderwort berries, treasures, Exploration Kit treasures, and the numbered pellets. Includes carry weights, pokos earned, seeds earned, and the depth treasures are buried. || Notepad++
|-
| <code>user/Abe/piki/naviParms.txt</code> || [[NaviParms|Leader parameters]], like speed and attack power. || Notepad++
|-
| <code>user/Abe/piki/pikiParms.txt</code> || [[PikiParms|Pikmin parameters]], like speed and attack power. || Notepad++
|-
| <code>user/Abe/stages.txt</code> || List of aboveground areas and parameters. || Notepad++
|-
| <code>user/Abe/time/time.ini</code> || Day cycle parameters, controlling the length of the day and the related events that occur. || Notepad++
|-
| <code>user/Abe/vs/stages.txt</code> || [[2-Player Battle stage parameters|List of 2-Player Battle stages and parameters]]. || Notepad++
|-
| <code>user/Abe/vs/vs_X_*.txt</code> || [[Cave fixed layout|Pre-determined layouts]] for the 2-Player Battle stages, listing the cave units they use and their locations. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/</code> || style="background-color:#ffffcc"|Yasushi Ebisawa's folder, who programmed the particle effects and title screen.
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/card_e_reader/</code> || style="background-color:#ffffcc"|<code>.DWN</code> files for the three e-Reader Pikmin minigames.
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/effect/</code> || style="background-color:#ffffcc"|<code>.JPC</code> [[Jsystem#JParticle|JParticle]] archive files. All of the game's used particles and effects. || jpc_conv, GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Ebisawa/testdata/</code> || style="background-color:#ffd1d1"|Unused menu files, e-Reader files, and title screen things. || FinModelUtility, SuperBMD (animations), RiiStudio, GameCube File Tools (for <code>.BTI</code> textures)
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/title/</code> || style="background-color:#ffffcc"|Models and <code>.BCK</code> animations for the title screen and enemies/Pikmin on it. || FinModelUtility, SuperBMD (animations), RiiStudio
|-
| <code>user/Ebisawa/title/title.szs/param/param_pikmin.txt</code> || [[Pikmin 2 title screen|Title screen Pikmin parameters]]. || Notepad++
|-
| <code>user/Ebisawa/title/title.szs/param/param_title.txt</code> || [[Pikmin 2 title screen|Title screen parameters]]. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Kando/</code> || style="background-color:#ffffcc"|Yuji Kando's folder, who programmed the Pikmin and other various systems.
|-
| <code>user/Kando/aiConstants.txt</code> || Some parameters for constants: gravity, Spiderwort berries needed to create 1 spray, amount needed to repay the debt, and "camera angle" (the Y-axis rotation for when you enter a stage). || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Kando/bridge/</code> || style="background-color:#ffd1d1"|Unused bridge models. || FinModelUtility, SuperBMD, RiiStudio, obj2grid (for the <code>.BIN</code> collision files), GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Kando/develop/</code> || style="background-color:#ffd1d1"|Leftover development tool resources, seemingly for a map editor, route/path manager, a [[Jsystem#J2DGraph|2D graphic]] tester, and animation tester, among other things. || FinModelUtility, SuperBMD, RiiStudio, GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Kando/effect/game.jpc</code> || style="background-color:#ffd1d1"|Unused <code>.JPC</code> [[Jsystem#JParticle|JParticle]] archive file with a bunch of particle effects. || jpc_conv, GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/effect/modeleffect.szs</code> || style="background-color:#ffffcc"|Onion beam model and <code>.BRK</code>/<code>.BTK</code> animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/maps/</code> || style="background-color:#ffffcc"|Models for aboveground/piklopedia areas, [[Pikmin 2 waterboxes|waterboxes]], and [https://www.pikminwiki.com/Pikmin_2_cave_generation#Backgrounds cave vrboxes]. || FinModelUtility, SuperBMD, RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffd1d1"|<code>user/Kando/mizu.bti</code> || style="background-color:#ffd1d1"|Unused texture. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/objects/</code> || style="background-color:#ffffcc"|Models and animations for some objects: clog, bridge, seesaw blocks, cave entrances, gates, nectar, geyser, Burgeoning Spiderwort mold, Pikmin head, Burgeoning Spiderwort, nectar rock, Ujadani, and nectar weed. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/onyon/</code> || style="background-color:#ffffcc"|Onion models and animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/piki/</code> || style="background-color:#ffffcc"|Model and animations for Pikmin, leaders, and the cursor + reticle. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/pod*/</code> || style="background-color:#ffffcc"|Research Pod model and animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffd1d1"|<code>user/Kando/resulttex/</code> || style="background-color:#ffd1d1"|Unused old Treasure Hoard icons, likely for cave/day end results. || GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Kando/texCaster/arc.szs/tex.bti</code> || style="background-color:#ffd1d1"|Unused texture. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/ufo*/</code> || style="background-color:#ffffcc"|Hocotate Ship model and animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/vstex/</code> || style="background-color:#ffffcc"|2-Player Battle Roulette icons and other minor HUD textures. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/zukan/</code> || style="background-color:#ffffcc"|Slightly simpler copy of the unused test map, with its own generation and lighting settings. || Gen & Route Editor (for routes/finding coords for [[Pikmin 2 waterboxes|waterboxes]]), Notepad++ (for .txt files/.ini lighting)
|-
|-
| style="background-color:#ffffcc"|<code>user/Koono/</code> || style="background-color:#ffffcc"|Hiroyuki Kono (Koono)'s folder, who programmed menus for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Koono/mail_icon.szs</code> || style="background-color:#ffffcc"|Space mail icons. || GameCube File Tools
|-
| <code>user/Koono/mail_table.szs/mail_table.bin</code> || IDs from the <code>.BMG</code> that correspond to each piece of [[mail]]. || Hex Editor
|-
| style="background-color:#ffffcc"|<code>user/Matoba/</code> || style="background-color:#ffffcc"|Taku Matoba's folder, who designed caves for ''Pikmin 2''.
|-
| <code>user/Matoba/challenge/stages.txt</code> || [[Pikmin 2 Challenge Mode settings|List of Challenge Mode stages and parameters]]. || Notepad++
|-
| <code>user/Matoba/challenge/kfes-stages.txt</code> || List of Challenge Mode stages and parameters, when the game is in KFes mode. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Matoba/resulttex/</code> || style="background-color:#ffffcc"|Treasure icons used in the Treasure Hoard and cave/day end results. || GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Morimura/</code> || style="background-color:#ffd1d1"|Naoya Morimura's leftover folder, who programmed the more complicated enemies for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Mukki/</code> || style="background-color:#ffffcc"|Yutaka Hiramuki's folder, who designed caves for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Mukki/mapunits/arc/</code> || style="background-color:#ffffcc"|[[Cave unit generation|Cave unit assets and data]]. Contains models, routes/pathfinding, and [[Pikmin 2 waterboxes|waterboxes]]. || FinModelUtility, SuperBMD, RiiStudio, obj2grid (for the <code>.BIN</code> collision files, Gen & Route Editor (for routes/finding coords for waterboxes), Notepad++ (for waterboxes), GameCube File Tools (for radar texture)
|-
| style="background-color:#ffffcc"|<code>user/Mukki/caveinfo/</code> || style="background-color:#ffffcc"|[[Cave generation parameters|Cave generation files]]. || Drought Ender's Cave Creator, Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Mukki/units/</code> || style="background-color:#ffffcc"|[[Cave unit definition file|Cave unit definition files]]. || Drought Ender's Cave Creator, Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Mukki/movie/</code> || style="background-color:#ffffcc"|[[STB file|<code>.STB</code> files]]. In-game cutscenes. || pikmin2-stb
|-
| style="background-color:#ffffcc"|<code>user/Nishimura/</code> || style="background-color:#ffffcc"|Katsushito Nishimura's folder, who programmed enemies and the levels for ''Pikmin 2''.
|-
| <code>user/Nishimura/Camera/caveCameraParms.txt</code> || [[Pikmin 2 camera parameters|Camera parameters]] when in caves. || Notepad++
|-
| <code>user/Nishimura/Camera/groundCameraParms.txt</code> || [[Pikmin 2 camera parameters|Camera parameters]] when aboveground. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/引きカメラcameraParms.txt</code> || style="background-color:#ffd1d1"|Unused [[Pikmin 2 camera parameters|camera parameters]].
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/撮影cameraParms.txt</code> || style="background-color:#ffd1d1"|Unused [[Pikmin 2 camera parameters|camera parameters]].
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/本物 groundCameraParms.txt</code> || style="background-color:#ffd1d1"|Unused [[Pikmin 2 camera parameters|camera parameters]].
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/本物caveCameraParms.txt</code> || style="background-color:#ffd1d1"|Unused [[Pikmin 2 camera parameters|camera parameters]].
|-
| <code>user/Nishimura/Rumble/rumbleData.txt</code> || Controller rumble time and power parameters. || Notepad++
|-
| <code>user/Nishimura/Rumble/rumbleParms.txt</code> || Controller rumble modifier for distant objects. || Notepad++
|-
| <code>user/Nishimura/Shadow/shadowParms.txt</code> || Shadow parameters. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Ogawa/</code> || style="background-color:#ffd1d1"|Yuzuru Ogawa's leftover folder, who programmed menus for ''Pikmin 2'',
|-
| style="background-color:#ffffcc"|<code>user/Totaka/</code> || style="background-color:#ffffcc"|Kazumi Totaka's folder, who directed the sound design and created some music and sound effects for ''Pikmin 2''.
|-
| <code>user/Totaka/BgmList.txt</code> || List of all [[Pikmin 2 BMS file list|<code>.BMS</code> sequences]] and volume settings for each. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Totaka/BgmList_BgmTest.txt</code> || style="background-color:#ffd1d1"|List of all [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] in the game, with a leftover developer comment about compiling cave songs. || Notepad++
|-
| <code>user/Totaka/BgmList_Forest.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for Awakening Wood cave sublevels. || Notepad++
|-
| <code>user/Totaka/BgmList_Last.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for Wistful Wild cave sublevels. || Notepad++
|-
| <code>user/Totaka/BgmList_Tutorial.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for Valley of Repose cave sublevels. || Notepad++
|-
| <code>user/Totaka/BgmList_Yakushima.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for Perplexing Pool cave sublevels. || Notepad++
|-
| <code>user/Totaka/ChallengeBgmList.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for all Challenge Mode cave sublevels. || Notepad++
|-
| <code>user/Totaka/StreamList.txt</code> || List of all [[AST file list|streams]], their ID, and volume settings. || Notepad++
|-
| <code>user/Totaka/trackMap_Cond_T.txt</code> || [[Trackmap parameters|Track mappings]] that apply to caveconc and new_XX [[Pikmin 2 CND file list|<code>.CND</code> conductor files]]. || Notepad++
|-
| <code>user/Totaka/trackMap_Seq_T.txt</code> || [[Trackmap parameters|Track mappings]] that apply to caveglass and caverelax [[Pikmin 2 BMS file list|<code>.BMS</code> sequences]]. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Wakai/</code> || style="background-color:#ffffcc"|Hajime Wakai's folder, who wrote music for ''Pikmin 2''.
|-
| <code>user/Wakai/trackMap_Cond_W.txt</code> || [[Trackmap parameters|Track mappings]] that apply to cavemetal and cavesoil [[Pikmin 2 CND file list|<code>.CND</code> conductor files]]. || Notepad++
|-
| <code>user/Wakai/trackMap_Seq_W.txt</code> || [[Trackmap parameters|Track mappings]] that apply to a few of Hajime Wakai's [[Pikmin 2 BMS file list|<code>.BMS</code> sequences]].|| Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/</code> || style="background-color:#ffffcc"|Yoshikazu Yamashita's folder, who did system programming and programmed most of the enemies for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/arc/</code> || style="background-color:#ffffcc"|Boot screen textures. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/enemytex/</code> || style="background-color:#ffffcc"|Piklopedia icons. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/zukan/</code> || style="background-color:#ffffcc"|Piklopedia enemy appearance parameters and day cycle lighting parameters. || Notepad++
|-

[[Category:Pikmin 2]]
[[Category:Directory trees]]

Cave generation parameters

2024-05-10T05:56:08Z

Waffles: /* FloorInfo */

In ''Pikmin 2'', the files that define a cave's settings can be found in <code>/user/Mukki/mapunits/caveinfo</code>. For instance, the Emergence Cave uses <code>tutorial_1.txt</code>. All comments (Japanese or English statements followed by a <code>#</code>) are unnecessary and deleting them will save file space.

To avoid any issues when reading or writing these files, use [https://notepad-plus-plus.org/download/v7.5.6.html Notepad++].

== Concepts ==
It is important to know these basic concepts.

Each object-related block in a sublevel has a series of data on what objects to spawn, and how. In this page, each of these data is called an '''entry'''. Each entry merely contains information about ''how'' to spawn an object, it does not actually reflect a specific object. For instance, there could be an entry for a Dwarf Bulborb that fall from the sky carrying the Essence of Desire, but the game could spawn 10 Dwarf Bulborbs from this entry – in this case all ten would fall from the sky and carry the Essence of Desire.

Each entry can belong to one of the following categories, which affect many things, some of which are detailed in this table:

{| class="wikitable sortable"
! Category || Block || Kind of object || Locations || Min. amount? || Used for filler? || Other notes
|-
! Main
| [[#TekiInfo|TekiInfo]]
| Anything but treasures and gates
| "Room" cave units
| Yes
| Until the limit in [[#FloorInfo|parameter <code>{f002}</code>]]
| [[#Spawn type|Spawn type]] is 0, 1, 5, or 8
|-
! Decorative
| [[#TekiInfo|TekiInfo]]
| Anything but treasures and gates
| "Room" cave units
| Yes
| No
| [[#Spawn type|Spawn type]] is 6
|-
! Treasure
| [[#ItemInfo|ItemInfo]]
| Treasures only
| "Room" cave units or those with "item" in the name
| Yes
| Until the limit in [[#FloorInfo|parameter <code>{f003}</code>]]
|
|-
! Gate
| [[#GateInfo|GateInfo]]
| Gates only
| Seams between units
| No
| Until the limit in [[#FloorInfo|parameter <code>{f004}</code>]]
|-
! Dead end
| [[#CapInfo|CapInfo]]
| Anything but gates
| "Dead end" cave units with "item" in the name
| Yes
| Until it runs out of dead ends
|
|}

These categories are not recognized by the game, and their names are merely guidelines. This is because you can have fully-functional enemies in the "decorative" category, and you can have cosmetic plants in the "main" category, for instance. What is important is understanding that the game reads and controls object entries differently depending on a lot of factors, and this categorization is just a simple way of explaining everything.

While this page explains how the text file works, it will not explain how spawning works. For that, there is the '''[[cave spawning]]''' article. You don't need to read the whole thing, but for context for this article, you should at least read the [[Cave spawning#Summary|summary]].

== Format ==
These text files must be encoded in Shift-JIS, or at least ASCII. If the file is saved as a UTF-8 text file with the <code>EF BB BF</code> magic word at the start, the game will not read it correctly, assuming you only have one sublevel. With Notepad++, you can check if the encoding is right in the bottom right.

Each file starts with the header, [[#CaveInfo|CaveInfo]]. Afterwards comes the data for each sublevel. Each sublevel consists of five consecutive blocks of information: [[#FloorInfo|FloorInfo]], [[#TekiInfo|TekiInfo]], [[#ItemInfo|ItemInfo]], [[#GateInfo|GateInfo]], and [[#CapInfo|CapInfo]].

When this page refers to "parameters", it means something along the lines of <code>{f000} 4 0</code>. The first word is the parameter's name. The second word is the type: <code>4</code> for numbers and <code>-1</code> for strings. The third word is the parameter's value – the one you can modify.

=== CaveInfo ===
The header block is usually commented with <code>CaveInfo</code>. It contains only one parameter, <code>{c000}</code>, which controls the number of sublevels in the cave.

After the opening block there is a lone number. This number is, once again, the number of sublevels in the cave.

=== FloorInfo ===
Each sublevel starts with a block typically commented with <code>FloorInfo</code>. It has a large number of parameters that determine how the sublevel works. The following table lists what parameters exist, what they do, and what comments (in Japanese) usually follow the value.

{{todo|Figure out what happens if you change {f000} and {f001}. Also specify what happens if {f003}/{f004} are set to 0.}}

{| class="wikitable sortable"
|-
! Parameter || Description || Japanese comment
|-
| <code>{f000}</code> || The sublevel number this sublevel belongs to, minus 1. For example, if this floor is sublevel 1, the value is 0. Comment translates to "floor introduction". Seems to crash the game if lower than the current sublevel. || 階はじめ
|-
| <code>{f001}</code> || Same as above. Comment translates to "floor end". Seems to duplicate the floor and replace future sublevels. For example, if you are on sublevel 1 ({f000} is set to 0) when {f001} is set to 2, sublevels 2 and 3 will be the exact same as the first sublevel. The other sublevels will be untouched. || 階おわり
|-
| <code>{f002}</code> || Ideal maximum number of objects in the main [[#Concepts|category]]. See [[#Amount|here]] and [[#Weight|here]] for more details. If this is set to 0, absolutely no objects of the main category will spawn. || 敵最大数
|-
| <code>{f003}</code> || Same as <code>{f002}</code> but for objects in the treasure [[#Concepts|category]]. It does not count treasures inside enemies. || アイテム最大数
|-
| <code>{f004}</code> || Same as <code>{f002}</code> but for objects in the gate [[#Concepts|category]]. || ゲート最大数
|-
| <code>{f005}</code> || Number of "room" cave units. || ルーム数
|-
| <code>{f006}</code> || Corridor probability. If this number is higher, the game will spawn more corridors relative to the number of rooms. || ルートの割合
|-
| <code>{f007}</code> || 1 if this floor has a geyser, 0 otherwise. || 帰還噴水(1=あり)
|-
| <code>{f008}</code> || [[Cave unit definition file]] name. || 使用ユニット
|-
| <code>{f009}</code> || Lighting definition file name. || 使用ライト
|-
| <code>{f00A}</code> || Skybox. Existing skyboxes are: <code>ice</code> (ice cavern), <code>test</code> (cavern), <code>build</code> (steel), <code>hiroba</code> (garden), <code>flooring</code> (wooden floor), <code>tatami</code> (carpet). If an invalid name is used, then there will be no skybox. || VRBOX
|-
| <code>{f010}</code> || 1 if the next sublevel hole is clogged, 0 otherwise. || 階段を壊す岩で隠す(0=オフ 1=オン)
|-
| <code>{f011}</code> || Echo strength; 0 for longest echo, used in soil/remaining themes, 1 is normally used for metal, 2 is used for concrete, 3 is used for tile, 4 is used for garden, and 5 is an almost unnoticeable echo, used for toy themes. || α属性
|-
| <code>{f012}</code> || Music type; 0 for normal, 1 to mute (until a boss), 2 to use rest sublevel music || β属性
|-
| <code>{f013}</code> || 1 if sublevel has an invisible solid plane of ground, generally used for the <code>hiroba</code>, <code>flooring</code> and <code>tatami</code> skyboxes. If 0, Pikmin can fall off the edge to their deaths. || 隠し床
|-
| <code>{f014}</code> || Dead end probability (0-100). E.g. if this value is 50, open doors will be set to dead ends with 50% probability. || キャップ最大数
|-
| <code>{f015}</code> || File format version; 1 is normal, 0 will ignore all dead end spawns ([[#CapInfo|CapInfo]]) || Version
|-
| <code>{f016}</code> || {{unsure|Time until the Waterwraith appears. || BlackManTimer
|-
| <code>{f017}</code> || 0 is normal, anything else makes it spawn two (connected) seesaw blocks randomly in the level. May spawn the leaders and Pikmin inside one. '''Unused.''' || 沈む壁
|}

=== TekiInfo ===
<code>TekiInfo</code> determines the [[#Concepts|main category]] objects and the [[#Concepts|decorative category]] objects to spawn on the sublevel. It also controls what sort of spawn points they appear in, if they fall from the sky or not, if they are carrying a treasure inside, and more. Gates and treasures cannot be specified here (other than the treasures that are [[#Carrying|carried]] by enemies). The game will spawn the minimum amounts specified in these entries and then, in the case of main category objects, keep filling randomly until the limit in [[#FloorInfo|parameter <code>{f002}</code>]]. These objects only appear in "room" cave units.

The first number in the block is the total of [[#Entry|entries]]. It is usually commented with <code>num</code>. Each entry consists of two lines:

# The first line in an entry starts with the object's [[#Fall method|fall method]], the object's [[#Class|class]], what treasure it is [[#Carrying|carrying]], then a space, then the [[#Amount|amount]] to spawn, and/or its [[#Weight|random filling weight]]. Note that entries of the decorative category do not have a random filling weight. It is typically commented with the word "weight".
# The second line of each entry is the [[#Spawn type|spawn type]]. It is typically commented with the word "type".

=== ItemInfo ===
<code>ItemInfo</code> controls what [[#Concepts|treasure category]] objects spawn. The game will spawn the minimum amounts for these treasures, and then will keep filling randomly until it reaches the limit defined in [[#FloorInfo|parameter <code>{f003}</code>]]. Treasures inside enemies aren't included here, nor are they counted for the limit. Instead, they are defined in the [[#Carrying|carrying]] data of objects in [[#TekiInfo|TekiInfo]] or [[#CapInfo|CapInfo]]. Only treasures can be specified in this block – if you try to spawn something here that is not a treasure, the game will crash. These objects only appear in "room" cave units, or any unit that has "item" in the name.

The first number in the block is the total of [[#Entry|entries]]. It is usually commented with <code>num</code>. Each entry consists of one line:

# This line contains the object's [[#Class|class]], then a space, then the [[#Amount|amount]] to spawn, and/or its [[#Weight|random filling weight]]. It is typically commented with the word "weight".

=== GateInfo ===
{{todo|Confirm the claim that the weight only uses the last digit.}}
<code>GateInfo</code> controls what [[#Concepts|gate category]] objects will appear. Each individual gate on a sublevel is randomly colored, and always appears in seams. The game will spawn the number of gates defined in [[#FloorInfo|parameter <code>{f004}</code>]]. These objects appear in the seams between two cave units.

The first number in the block is the total of [[#Entry|entries]]. It is usually commented with <code>num</code>. Each entry consists of two lines:

# The first line is the gate's HP. This line starts with any word (although the word <code>gate</code> is what's used in the vanilla game), and after a space, the amount of hit points it has, with decimal places (e.g. <code>1000.000000</code>). It is typically commented with the word "life".
# The second line contains the object's [[#Weight|random filling weight]]. Only the last digit is read by the game, though. If the weight number is 0, the game will not spawn any gate from this entry, of course. It is typically commented with the word "weight".

=== CapInfo ===
<code>CapInfo</code> determines what [[#Concepts|dead end category]] objects to spawn. It works similarly to the [[#TekiInfo|<code>TekiInfo</code> block]], though with some differences:
* While in the <code>TekiInfo</code> block the locations of objects spawned is determined by the spawn type, that is not the case here. These objects only spawn in "dead end" cave units with "item" in the name.
* Objects spawned with this block do not count for any limit (e.g. [[#FloorInfo|parameter <code>{f003}</code>]]).
* Treasures can also be specified in this block.

The first number in the block is the total of [[#Entry|entries]]. It is usually commented with <code>num</code>. Each entry consists of three lines:

# The first line is presumably, the type of dead end this spawn applies to. It always has the value <code>0</code> in the vanilla game. It is typically commented with the word "captype".
# The second line in an entry starts with the object's [[#Fall method|fall method]], the object's [[#Class|class]], what treasure it is [[#Carrying|carrying]], then a space, then the [[#Amount|amount]] to spawn, and/or its [[#Weight|random filling weight]]. It is typically commented with the word "weight".
# The third line of each entry is the "type". 0 makes it so two objects spawn in the same spot, while 1 allows only one object. It is typically commented with the word "type".

== Entry ==
Depending on its [[#Concepts|category]], an entry can have or not have certain information.

To note is that if something is wrong with the entry's data, the game will probably break down when trying to spawn an item of said entry, but it might also trigger an error handler. If it does, the object will be turned into a fully-functional Common Glowcap. Typing an invalid class name will trigger the error handler.

=== Class ===
[[#Concepts|Categories]]: main, decorative, treasure, dead end.

This is the class of object to spawn (e.g. fire geyser, Red Bulborb, clover, etc.). The name typed here must match the [[Pikmin 2 identifiers|internal name]]. (e.g. <code>MaroFrog</code> for a Wollywog.) For main, decorative, and dead end category objects, this name is normally not case-sensitive, but if it's an enemy [[#Carrying|carrying]] something, then it becomes case-sensitive. For treasure category objects, the name must be all lowercase.

=== Carrying ===
[[#Concepts|Categories]]: main, decorative, dead end.

An entry can specify if an enemy is meant to carry a treasure inside it. If it is, then after the [[#Class|class]] name there should be an underscore, and then afterwards, in all lowercase, the [[Pikmin 2 identifiers|internal name]] of said treasure. (e.g. <code>Chappy_key</code> for a Red Bulborb carrying The Key.) Note that for entries regarding enemies that are carrying something, the class name becomes case-sensitive.

Note that just because an underscore exists doesn't mean for sure that one object is carrying another. If the game sees the name <code>Wakame_s</code>, it isn't going to think that it's an object <code>Wakame</code> carrying an object <code>s</code>, but rather that it is a small shoot. Also note that treasures specified here do not count towards the limit in [[#FloorInfo|parameter <code>{f003}</code>]].

=== Fall method ===
[[#Concepts|Categories]]: main, decorative, dead end.

Some objects spawn in the sky and then fall, like Volatile Dweevils that only appear when you get close to their spawn position. To get an object to do this, write a dollar sign and/or a number, before the [[#Class|class]] of the entry, without a space in between. (e.g. <code>$4BombOtakara</code> for a Volatile Dweevil that spawns when Pikmin are carrying nearby). You have to write a specific thing to get a specific behavior, and if you write an invalid one, the game crashes:

{| class="wikitable sortable"
! Code || Effect || Notes
|-
| (Nothing) || Spawns normally. ||
|-
| <code>$</code> || Falls, if a Pikmin or leader is nearby. ||
|-
| <code>$0</code> || Triggers the Common Glowcap error handler. || '''Unused'''.
|-
| <code>$1</code> || Identical to <code>$</code>. ||
|-
| <code>$2</code> || Falls, if a Pikmin is nearby. Leaders are ignored. ||
|-
| <code>$3</code> || Falls, if a leader is nearby. Pikmin are ignored. || '''Unused'''.
|-
| <code>$4</code> || Falls, if Pikmin are carrying nearby. ||
|-
| <code>$5</code> || Falls, if a Purple Pikmin causes an earthquake nearby. ||
|}

Not all objects support this feature. The objects that don't support the feature completely ignore whatever fall method is written and spawn normally. Other objects support it, but have some interesting behavior. Here is a list of all possibilities:

{| class="wikitable mw-collapsible mw-collapsed"
! Objects || Result
|-
|
* All bosses
* All plants (besides Candypop Buds)
* Antenna Beetle
* Armored Cannon Beetle Larva (buried version)
* Breadbug
* Cloaking Burrow-nit
* Creeping Chrysanthemum
* Doodlebug
* Electrical wire
* Female Sheargrub
* Fire geyser
* Gas pipe
* Hermit Crawmad
* Honeywisp
* Iridescent Flint Beetle
* Iridescent Glint Beetle
* Male Sheargrub
* Mamuta
* Mitite
* Ravenous Whiskerpillar
* Shearwig
* Skitter Leaf
* Toady Bloyster
* Unmarked Spectralids
* Waterwraith rollers (unused)
| Not supported
|-
|
* Bumbling Snitchbug
* Careening Dirigibug
* Greater Spotted Jellyfloat
* Lesser Spotted Jellyfloat
* Puffy Blowhog
* Swooping Snitchbug
* Withering Blowhog
| Supported, floats down from the sky
|-
|
* Bulborb Larva – Uses a unique falling animation, the same animation that's used when it is born from the Empress Bulblax.
* Egg – Breaks upon hitting the ground.
* Falling boulder – Falling boulders sort of float in place for a bit, then fall down at a much quicker speed than normal. If multiple boulders spawn inside of each other, they will bounce off of each other at an angle when they are triggered by the player.
* Lithopod boulder (unused) – The trail particles of the boulder will remain stationary in the air until the rolling boulder is triggered by the player.
| Supported, special behavior
|-
|
* Everything else
| Supported, falls normally
|}

=== Amount ===
[[#Concepts|Categories]]: main, decorative, treasure, dead end.

Some entries can specify that the sublevel must spawn at least a minimum amount of objects from that entry. The game can possibly [[#Weight|spawn more randomly]] afterwards, but at least the minimum amount will be met (under ideal circumstances anyway). Note that while there are sublevel [[#FloorInfo|parameters]] that control the maximum number of main, treasure, or gate objects, they will not be taken into account when spawning these minimum amounts.

In an entry, the amount comes after the [[#Class|class]] (and [[#Carrying|carry]]), with a space in between. Whatever number is written here is the minimum amount. 0 can be used to specify that there is no minimum amount, and that this entry should only be used for random filler. The filler weight, described [[#Weight|here]], is another number that goes attached to this one. If the filler weight is present, then the amount number can be absent; in this case the game will assume it is 0. Note that while gate category entries need the minimum amount, the game will not actually do anything with that amount.

=== Weight ===
[[#Concepts|Categories]]: main, treasure, gate, dead end.

When the game wants to fill in the sublevel with some randomly-picked objects, it checks the relevant entries to figure out which ones it can pick, and with what chances, as detailed [[Cave spawning#Weighted distribution|here]]. It eventually stops spawning, and the exact conditions depend the [[#Concepts|category]] of the entry. Note that for many reasons, explained in the [[cave spawning]] article, objects may fail to appear, so the sublevel will contain fewer objects of a given category than the sublevel [[#FloorInfo|parameter]] for that limit specifies.

In an entry, the random filling weight comes directly after the [[#Amount|amount]], without even a space in between. The weight is only one digit, meaning it can only go from 0 to 9. If it is 0, the game will not use this entry for random filling. Note that if only one digit is present, then it refers to the weight, and the game assumes the minimum amount is 0. Also note that entries of the decorative category do not have weight.

{{credits|Jimble, [[User:Espyo|Espyo]]}}

=== Spawn type ===
[[#Concepts|Categories]]: main, decorative.

This number controls what type of spawning logic to use, where it spawns, and to a lesser degree, what category of object this is. The number ranges from 0 to 8, and most of these also correspond to a group of spawn coordinates. When spawning an instance of this object, the game picks a random coordinate from the group, if applicable. Note that certain entry categories can only use certain numbers.

The following table lists the possible numbers, and the comments on the various [[Cave unit definition file|unit layout files]] (in <code>/user/Mukki/mapunits/arc/*/texts.szs/layout.txt</code>) are also included due to them helping understand what each number means.

{| class="wikitable"
! rowspan="2" | Group || rowspan="2" | Content || rowspan="2" | <code>layout.txt</code> comment || rowspan="2" | Notes || colspan="2" | Category availability
|-
! Main || Decorative
|-
| 0 || "Easy" enemy group || <code>Teki A</code> || Commonly used for easier enemies. Objects using this spawn type can spawn multiple in the same spot. (Depends on the spawn point's minimum and maximum amount.) || style="background-color: #aca;" | Yes || style="background-color: #caa;" | No
|-
| 1 || "Hard" enemy group || <code>Teki B</code> || Commonly used for harder enemies. || style="background-color: #aca;" | Yes || style="background-color: #caa;" | No
|-
| 2 || Treasure || <code>Item</code> || Not used directly by any object in the vanilla game. In a cave unit, it marks the location of objects from the treasure category. || style="background-color: #caa;" | No || style="background-color: #caa;" | No
|-
| 3 || {{unsure|Unknown}} || || There is no object or cave unit that uses this number. || style="background-color: #caa;" | No || style="background-color: #caa;" | No
|-
| 4 || Hole/Geyser || <code>FixObj</code> || Objects can't use this number. In a cave unit, it marks a viable location for the next sublevel hole/geyser in a room, if dead ends are not present in the sublevel. || style="background-color: #caa;" | No || style="background-color: #caa;" | No
|-
| 5 || Seams || || Commonly used for hazards such as fire geysers, electrical wires and gas pipes. These spots are located in the seams between two connected cave units. || style="background-color: #aca;" | Yes || style="background-color: #caa;" | No
|-
| 6 || Plant || <code>Plant</code> || Commonly used by decorative plants. || style="background-color: #caa;" | No || style="background-color: #aca;" | Yes
|-
| 7 || Leader spawn || <code>Start</code> || Objects can't use this number. In a cave unit, it marks a possible player starting spot in the sublevel. The Y coordinate is ignored; it snaps to the ground. || style="background-color: #caa;" | No || style="background-color: #caa;" | No
|-
| 8 || "Special" enemy group || <code>Teki F</code> || Commonly used for boss locations, or the location of tower Gatling Groinks/buried Armored Cannon Beetle Larvae. Most rooms do not have coordinates for this. || style="background-color: #aca;" | Yes || style="background-color: #caa;" | No
|}

[[Category:Pikmin 2]]
[[Category:File formats]]

Pikmin 2 directory tree

2024-05-09T13:11:32Z

Waffles: simplify

{{DISPLAYTITLE:''Pikmin 2'' directory tree}}
This article lists all folders and noteworthy files in ''Pikmin 2'', and recommended tools for viewing or modifying them. 
Yellow rows are folders, and red rows are unused files or folders with no effect on the game.

{{todo|Add links for everything.}}

{| class="wikitable sortable"
! Path || Details || Recommended Tool
|-
| style="background-color:#ffffcc"|<code>AudioRes/</code> || style="background-color:#ffffcc"|[[Jsystem#JAudio|JAudio]] resources. Contains data for music, instruments, and sound effects. || Pikmin 2 Sound Modding Toolkit
|-
| style="background-color:#ffffcc"|<code>AudioRes/Banks</code> || style="background-color:#ffffcc"|[[AW file|<code>.AW</code> wave scene files]]. Contain audio samples of instruments and sound effects for the instrument programs. || Pikmin 2 Sound Modding Toolkit
|-
| style="background-color:#ffd1d1"|<code>AudioRes/BgmList.txt</code> || style="background-color:#ffd1d1"|Early list of [[Pikmin 2 BMS file list|sequences]] and volume settings. The real <code>BgmList.txt</code> is in Totaka's folder. || Notepad++
|-
| style="background-color:#ffffcc"|<code>AudioRes/Conductor.arc/</code> || style="background-color:#ffffcc"|[[Pikmin 2 CND file list|<code>.CND</code> conductor files]]. Creates music for caves. || Hex Editor
|-
| style="background-color:#ffffcc"|<code>AudioRes/Key.arc/</code> || style="background-color:#ffffcc"|<code>.BAS</code> files, which link SoundIDs to enemy animations. || Hex Editor
|-
| style="background-color:#ffd1d1"|<code>AudioRes/Key.arc/enemy.prj</code> || style="background-color:#ffd1d1"|Leftover project information about the <code>.BAS</code> files.
|-
| <code>AudioRes/PSound.aaf</code> || [[AFF file|<code>.AAF</code> audio archive file]]. Integral file that contains information about all the available sound effects, waves, instrument banks + programs, and music. || Pikmin 2 Sound Modding Toolkit
|-
| <code>AudioRes/PSound.asn</code> || <code>.ASN</code> audio sound names. Contains a list of all SoundIDs, which reference a sequence from <code>se.bms</code>. || asn2csv
|-
| style="background-color:#ffffcc"|<code>AudioRes/Seqs/Seq.arc/</code> || style="background-color:#ffffcc"|[[Pikmin 2 BMS file list|<code>.BMS</code> binary music sequences]]. Contains sequenced music (akin to MIDI files). || flaaffy or JAIMaker
|-
| <code>AudioRes/Seqs/Seq.arc/se.bms</code> || Special <code>.BMS</code> file containing all sound effect sequences in the game. || p2setoolkit, flaaffy or JAIMaker
|-
| style="background-color:#ffffcc"|<code>AudioRes/Stream/</code> || style="background-color:#ffffcc"|[[AST file list|<code>.AST</code> audio streams.]] Contains streamed music (akin to WAV or MP3 files). || JATAST
|-
| style="background-color:#ffd1d1"|<code>banner/</code> || style="background-color:#ffd1d1"|Contains three different Gamecube banner images for ''Pikmin 2''. This folder is unused; depending on the region, one of these was copied and placed into the root directory as <code>opening.bnr</code> || pyisotools
|-
| style="background-color:#ffffcc"|<code>enemy/</code> || style="background-color:#ffffcc"|Enemy data. Also includes plants, hazards, and misc. objects.
|-
| style="background-color:#ffffcc"|<code>enemy/common/enemyCommon.szs/</code> || style="background-color:#ffffcc"|Models of the rocks used in petrification. || FinModelUtility, SuperBMD, RiiStudio
|-
| style="background-color:#ffffcc"|<code>enemy/data/</code> || style="background-color:#ffffcc"|Enemy models, <code>.BCA</code> animations, and textures. || FinModelUtility, SuperBMD (animations), RiiStudio, GameCube File Tools (for <code>.BTI</code> textures).
|-
| style="background-color:#ffffcc"|<code>enemy/parm/enemyParms.szs/</code> || style="background-color:#ffffcc"|[[Pikmin 2 enemy parameters|Parameters for enemy HP, damage, move speed, collisions, animations, and ultra-bitter petrification models]]. || Notepad++, Pikmin 2 Enemy Collision Tree Blender Addon, Pikmin 2 Enemy Bitter/Stoneinfo Blender Addon
|-
| <code>enemy/parm/enemyResList.txt</code> || List of enemy resource file paths. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>*gameConfig.ini</code> || style="background-color:#ffd1d1"|These were likely game configuration settings that changed how the game was compiled, to create special versions of ''Pikmin 2''. || Notepad++
|-
| style="background-color:#ffffcc"|<code>memoryCard/memoryCardHeader.szs/</code> || style="background-color:#ffffcc"|Memory card menu icons and banner images. || Wiimms Image Tool + Hex Editor
|-
| <code>message/font_*.szs/pikmin2main.bfn</code> || Font data and textures. || bfntoolkit + GameCube File Tools
|-
| <code>message/mesRes_*.szs/pikmin2.bmc</code> || Data for font coloring. || Hex Editor
|-
| <code>message/mesRes_*.szs/pikmin2.bmg</code> || [[BMG file]], all text strings and dialog in the game. || pikminBMG
|-
| style="background-color:#ffffcc"|<code>new_screen/</code> || style="background-color:#ffffcc"|[[BLO file|<code>.BLO</code>files]]: HUDs, interfaces, and menus, with all their resources like graphics and animations. || pyblo2-gui
|-
| <code>opening.bnr</code> || Gamecube banner image. || pyisotools
|-
| <code>pikmin2*P.MAP</code> || Symbol map. Text file that lists where every function and piece of data in the game's code is located and its name, and is used in-game by the crash handler for debugging purposes. The symbol map in retail versions of the game is unreadable. || Notepad++
|-
| style="background-color:#ffffcc"|<code>thp/</code> || style="background-color:#ffffcc"|[[THP file|<code>.THP</code>files]]. Pre-rendered videos. The .ini files control when text strings are loaded on top of the videos. || wiiflowthpvideoconverter, Notepad++ (for .ini files)
|-
| style="background-color:#ffd1d1"|<code>timeStamp*.txt</code> || style="background-color:#ffd1d1"|Build dates. "J", "P", and "U" likely represent the Japanese, PAL, and US versions. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/</code> || style="background-color:#ffffcc"|Masamichi Abe's folder, who was a director for the game.
|-
| style="background-color:#ffffcc"|<code>user/Abe/cave/</code> || style="background-color:#ffffcc"|[[Pikmin 2 cave lighting files|Lighting files for caves]]. || Drought Ender's Cave Creator, Notepad++
|-
| <code>user/Abe/item/barrelParms.txt</code> || Clog health parameter. || Notepad++
|-
| <code>user/Abe/item/bridgeParms.txt</code> || Bridge health parameter. || Notepad++
|-
| <code>user/Abe/item/fountainParms.txt</code> || Challenge Mode Geyser health parameter. || Notepad++
|-
| <code>user/Abe/item/plantParms.txt</code> || Burgeoning Spiderwort parameters. || Notepad++
|-
| <code>user/Abe/item/rockParms.txt</code> || Burgeoning Spiderwort mold parameters. || Notepad++
|-
| <code>user/Abe/item/TreasureParms.txt</code> || Buried treasure health parameters. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/map/</code> || style="background-color:#ffffcc"|Routes/pathing, [[Pikmin 2 area generator file|object generation]], [[Pikmin 2 map lighting files|day cycle lighting]], and settings for aboveground areas (including the test map and Piklopedia areas). || Gen & Route Editor, Notepad++ (for .txt files/.ini lighting)
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/</code> || style="background-color:#ffffcc"|All treasure models and their <code>.BCK</code> carrying animations, as well as parameters for all carriable objects. || FinModelUtility, SuperBMD (animations), RiiStudio, Notepad++ (for collision/parameters)
|-
| style="background-color:#ffd1d1"|<code>user/Abe/Pellet/*/carcass_config.txt</code> || style="background-color:#ffd1d1"|Unused enemy carcass parameters. The real parameters are in <code>/user/Abe/Pellet/*/pelletlist_*.szs</code>. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Abe/Pellet/*/item_config.txt</code> || style="background-color:#ffd1d1"|Unused Exploration Kit treasure parameters. The real parameters are in <code>/user/Abe/Pellet/*/pelletlist_*.szs</code>. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/item_texts.szs</code> || style="background-color:#ffffcc"|Collision parameters for the Exploration Kit treasures, and their animation file paths. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Abe/Pellet/*/otakara_config.txt</code> || style="background-color:#ffd1d1"|Unused treasure parameters. The real parameters are in <code>/user/Abe/Pellet/*/pelletlist_*.szs</code>. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/otakara_texts.szs</code> || style="background-color:#ffffcc"|Collision parameters for the treasures, and their animation file paths. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/pellet.szs/</code> || style="background-color:#ffffcc"|All numbered pellet models, their <code>.BCK</code> carrying animations, and <code>.BRK</code> files that control their color. || FinModelUtility, SuperBMD (animations), RiiStudio
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/pellet_texts.szs/</code> || style="background-color:#ffffcc"|Collision parameters for the numbered pellets, and their animation file paths. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/pelletlist_*.szs</code> || style="background-color:#ffffcc"|Carryable object parameters, including enemy carcasses, Spiderwort berries, treasures, Exploration Kit treasures, and the numbered pellets. Includes carry weights, pokos earned, seeds earned, and the depth treasures are buried. || Notepad++
|-
| <code>user/Abe/piki/naviParms.txt</code> || [[NaviParms|Leader parameters]], like speed and attack power. || Notepad++
|-
| <code>user/Abe/piki/pikiParms.txt</code> || [[PikiParms|Pikmin parameters]], like speed and attack power. || Notepad++
|-
| <code>user/Abe/stages.txt</code> || List of aboveground areas and parameters. || Notepad++
|-
| <code>user/Abe/time/time.ini</code> || Day cycle parameters, controlling the length of the day and the related events that occur. || Notepad++
|-
| <code>user/Abe/vs/stages.txt</code> || [[2-Player Battle stage parameters|List of 2-Player Battle stages and parameters]]. || Notepad++
|-
| <code>user/Abe/vs/vs_X_*.txt</code> || [[Cave fixed layout|Pre-determined layouts]] for the 2-Player Battle stages, listing the cave units they use and their locations. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/</code> || style="background-color:#ffffcc"|Yasushi Ebisawa's folder, who programmed the particle effects and title screen.
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/card_e_reader/</code> || style="background-color:#ffffcc"|<code>.DWN</code> files for the three e-Reader Pikmin minigames.
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/effect/</code> || style="background-color:#ffffcc"|<code>.JPC</code> [[Jsystem#JParticle|JParticle]] archive files. All of the game's used particles and effects. || jpc_conv, GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Ebisawa/testdata/</code> || style="background-color:#ffd1d1"|Unused menu files, e-Reader files, and title screen things. || FinModelUtility, SuperBMD (animations), RiiStudio, GameCube File Tools (for <code>.BTI</code> textures)
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/title/</code> || style="background-color:#ffffcc"|Models and <code>.BCK</code> animations for the title screen and enemies/Pikmin on it. || FinModelUtility, SuperBMD (animations), RiiStudio
|-
| <code>user/Ebisawa/title/title.szs/param/param_pikmin.txt</code> || [[Pikmin 2 title screen|Title screen Pikmin parameters]]. || Notepad++
|-
| <code>user/Ebisawa/title/title.szs/param/param_title.txt</code> || [[Pikmin 2 title screen|Title screen parameters]]. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Kando/</code> || style="background-color:#ffffcc"|Yuji Kando's folder, who programmed the Pikmin and other various systems.
|-
| <code>user/Kando/aiConstants.txt</code> || Some parameters for constants: gravity, Spiderwort berries needed to create 1 spray, amount needed to repay the debt, and "camera angle" (the Y-axis rotation for when you enter a stage). || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Kando/bridge/</code> || style="background-color:#ffd1d1"|Unused bridge models. || FinModelUtility, SuperBMD, RiiStudio, obj2grid (for the <code>.BIN</code> collision files), GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Kando/develop/</code> || style="background-color:#ffd1d1"|Leftover development tool resources, seemingly for a map editor, route/path manager, a [[Jsystem#J2DGraph|2D graphic]] tester, and animation tester, among other things. || FinModelUtility, SuperBMD, RiiStudio, GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Kando/effect/game.jpc</code> || style="background-color:#ffd1d1"|Unused <code>.JPC</code> [[Jsystem#JParticle|JParticle]] archive file with a bunch of particle effects. || jpc_conv, GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/effect/modeleffect.szs</code> || style="background-color:#ffffcc"|Onion beam model and <code>.BRK</code>/<code>.BTK</code> animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/maps/</code> || style="background-color:#ffffcc"|Models for aboveground/piklopedia areas, [[Pikmin 2 waterboxes|waterboxes]], and [https://www.pikminwiki.com/Pikmin_2_cave_generation#Backgrounds cave vrboxes]. || FinModelUtility, SuperBMD, RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffd1d1"|<code>user/Kando/mizu.bti</code> || style="background-color:#ffd1d1"|Unused texture. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/objects/</code> || style="background-color:#ffffcc"|Models and animations for some objects: clog, bridge, seesaw blocks, cave entrances, gates, nectar, geyser, Burgeoning Spiderwort mold, Pikmin head, Burgeoning Spiderwort, nectar rock, Ujadani, and nectar weed. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/onyon/</code> || style="background-color:#ffffcc"|Onion models and animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/piki/</code> || style="background-color:#ffffcc"|Model and animations for Pikmin, leaders, and the cursor + reticle. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/pod*/</code> || style="background-color:#ffffcc"|Research Pod model and animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffd1d1"|<code>user/Kando/resulttex/</code> || style="background-color:#ffd1d1"|Unused old Treasure Hoard icons, likely for cave/day end results. || GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Kando/texCaster/arc.szs/tex.bti</code> || style="background-color:#ffd1d1"|Unused texture. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/ufo*/</code> || style="background-color:#ffffcc"|Hocotate Ship model and animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/vstex/</code> || style="background-color:#ffffcc"|2-Player Battle Roulette icons and other minor HUD textures. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/zukan/</code> || style="background-color:#ffffcc"|Slightly simpler copy of the unused test map, with its own generation and lighting settings. || Gen & Route Editor (for routes/finding coords for [[Pikmin 2 waterboxes|waterboxes]]), Notepad++ (for .txt files/.ini lighting)
|-
|-
| style="background-color:#ffffcc"|<code>user/Koono/</code> || style="background-color:#ffffcc"|Hiroyuki Kono (Koono)'s folder, who programmed menus for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Koono/mail_icon.szs</code> || style="background-color:#ffffcc"|Space mail icons. || GameCube File Tools
|-
| <code>user/Koono/mail_table.szs/mail_table.bin</code> || IDs from the <code>.BMG</code> that correspond to each piece of [[mail]]. || Hex Editor
|-
| style="background-color:#ffffcc"|<code>user/Matoba/</code> || style="background-color:#ffffcc"|Taku Matoba's folder, who designed caves for ''Pikmin 2''.
|-
| <code>user/Matoba/challenge/stages.txt</code> || [[Pikmin 2 Challenge Mode settings|List of Challenge Mode stages and parameters]]. || Notepad++
|-
| <code>user/Matoba/challenge/kfes-stages.txt</code> || List of Challenge Mode stages and parameters, when the game is in KFes mode. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Matoba/resulttex/</code> || style="background-color:#ffffcc"|Treasure icons used in the Treasure Hoard and cave/day end results. || GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Morimura/</code> || style="background-color:#ffd1d1"|Naoya Morimura's leftover folder, who programmed the more complicated enemies for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Mukki/</code> || style="background-color:#ffffcc"|Yutaka Hiramuki's folder, who designed caves for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Mukki/mapunits/arc/</code> || style="background-color:#ffffcc"|[[Cave unit generation|Cave unit assets and data]]. Contains models, routes/pathfinding, and [[Pikmin 2 waterboxes|waterboxes]]. || FinModelUtility, SuperBMD, RiiStudio, obj2grid (for the <code>.BIN</code> collision files, Gen & Route Editor (for routes/finding coords for waterboxes), Notepad++ (for waterboxes), GameCube File Tools (for radar texture)
|-
| style="background-color:#ffffcc"|<code>user/Mukki/caveinfo/</code> || style="background-color:#ffffcc"|[[Cave generation parameters|Cave generation files]]. || Drought Ender's Cave Creator, Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Mukki/units/</code> || style="background-color:#ffffcc"|[[Cave unit definition file|Cave unit definition files]]. || Drought Ender's Cave Creator, Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Mukki/movie/</code> || style="background-color:#ffffcc"|[[STB file|<code>.STB</code> files]]. In-game cutscenes. || pikmin2-stb
|-
| style="background-color:#ffffcc"|<code>user/Nishimura/</code> || style="background-color:#ffffcc"|Katsushito Nishimura's folder, who programmed enemies and the levels for ''Pikmin 2''.
|-
| <code>user/Nishimura/Camera/caveCameraParms.txt</code> || [[Pikmin 2 camera parameters|Camera parameters]] when in caves. || Notepad++
|-
| <code>user/Nishimura/Camera/groundCameraParms.txt</code> || [[Pikmin 2 camera parameters|Camera parameters]] when aboveground. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/引きカメラcameraParms.txt</code> || style="background-color:#ffd1d1"|Unused [[Pikmin 2 camera parameters|camera parameters]].
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/撮影cameraParms.txt</code> || style="background-color:#ffd1d1"|Unused [[Pikmin 2 camera parameters|camera parameters]].
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/本物 groundCameraParms.txt</code> || style="background-color:#ffd1d1"|Unused [[Pikmin 2 camera parameters|camera parameters]].
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/本物caveCameraParms.txt</code> || style="background-color:#ffd1d1"|Unused [[Pikmin 2 camera parameters|camera parameters]].
|-
| <code>user/Nishimura/Rumble/rumbleData.txt</code> || Controller rumble time and power parameters. || Notepad++
|-
| <code>user/Nishimura/Rumble/rumbleParms.txt</code> || Controller rumble modifier for distant objects. || Notepad++
|-
| <code>user/Nishimura/Shadow/shadowParms.txt</code> || Shadow parameters. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Ogawa/</code> || style="background-color:#ffd1d1"|Yuzuru Ogawa's leftover folder, who programmed menus for ''Pikmin 2'',
|-
| style="background-color:#ffffcc"|<code>user/Totaka/</code> || style="background-color:#ffffcc"|Kazumi Totaka's folder, who directed the sound design and created some music and sound effects for ''Pikmin 2''.
|-
| <code>user/Totaka/BgmList.txt</code> || List of all [[Pikmin 2 BMS file list|<code>.BMS</code> sequences]] and volume settings for each. || Notepad++
|-
| <code>user/Totaka/BgmList_BgmTest.txt</code> || List of all [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] in the game, with a leftover developer comment about compiling cave songs. || Notepad++
|-
| <code>user/Totaka/BgmList_Forest.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for Awakening Wood cave sublevels. || Notepad++
|-
| <code>user/Totaka/BgmList_Last.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for Wistful Wild cave sublevels. || Notepad++
|-
| <code>user/Totaka/BgmList_Tutorial.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for Valley of Repose cave sublevels. || Notepad++
|-
| <code>user/Totaka/BgmList_Yakushima.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for Perplexing Pool cave sublevels. || Notepad++
|-
| <code>user/Totaka/ChallengeBgmList.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for all Challenge Mode cave sublevels. || Notepad++
|-
| <code>user/Totaka/StreamList.txt</code> || List of all [[AST file list|streams]], their ID, and volume settings. || Notepad++
|-
| <code>user/Totaka/trackMap_Cond_T.txt</code> || [[Trackmap parameters|Track mappings]] that apply to caveconc and new_XX [[Pikmin 2 CND file list|<code>.CND</code> conductor files]]. || Notepad++
|-
| <code>user/Totaka/trackMap_Seq_T.txt</code> || [[Trackmap parameters|Track mappings]] that apply to caveglass and caverelax [[Pikmin 2 BMS file list|<code>.BMS</code> sequences]]. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Wakai/</code> || style="background-color:#ffffcc"|Hajime Wakai's folder, who wrote music for ''Pikmin 2''.
|-
| <code>user/Wakai/trackMap_Cond_W.txt</code> || [[Trackmap parameters|Track mappings]] that apply to cavemetal and cavesoil [[Pikmin 2 CND file list|<code>.CND</code> conductor files]]. || Notepad++
|-
| <code>user/Wakai/trackMap_Seq_W.txt</code> || [[Trackmap parameters|Track mappings]] that apply to a few of Hajime Wakai's [[Pikmin 2 BMS file list|<code>.BMS</code> sequences]].|| Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/</code> || style="background-color:#ffffcc"|Yoshikazu Yamashita's folder, who did system programming and programmed most of the enemies for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/arc/</code> || style="background-color:#ffffcc"|Boot screen textures. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/enemytex/</code> || style="background-color:#ffffcc"|Piklopedia icons. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/zukan/</code> || style="background-color:#ffffcc"|Piklopedia enemy appearance parameters and day cycle lighting parameters. || Notepad++
|-

[[Category:Pikmin 2]]
[[Category:Directory trees]]

Pikmin 2 directory tree

2024-05-09T13:04:10Z

Waffles: trackmap

{{DISPLAYTITLE:''Pikmin 2'' directory tree}}
This article lists all folders and noteworthy files in ''Pikmin 2'', and recommended tools for viewing or modifying them. 
Yellow rows are folders, and red rows are unused files or folders with no effect on the game.

{{todo|Add links for everything.}}

{| class="wikitable sortable"
! Path || Details || Recommended Tool
|-
| style="background-color:#ffffcc"|<code>AudioRes/</code> || style="background-color:#ffffcc"|[[Jsystem#JAudio|JAudio]] resources. Contains data for music, instruments, and sound effects. || Pikmin 2 Sound Modding Toolkit
|-
| style="background-color:#ffffcc"|<code>AudioRes/Banks</code> || style="background-color:#ffffcc"|[[AW file|<code>.AW</code> wave scene files]]. Contain audio samples of instruments and sound effects for the instrument programs. || Pikmin 2 Sound Modding Toolkit
|-
| style="background-color:#ffd1d1"|<code>AudioRes/BgmList.txt</code> || style="background-color:#ffd1d1"|Early list of [[Pikmin 2 BMS file list|sequences]] and volume settings. The real <code>BgmList.txt</code> is in Totaka's folder. || Notepad++
|-
| style="background-color:#ffffcc"|<code>AudioRes/Conductor.arc/</code> || style="background-color:#ffffcc"|[[Pikmin 2 CND file list|<code>.CND</code> conductor files]]. Creates music for caves. || Hex Editor
|-
| style="background-color:#ffffcc"|<code>AudioRes/Key.arc/</code> || style="background-color:#ffffcc"|<code>.BAS</code> files, which link SoundIDs to enemy animations. || Hex Editor
|-
| style="background-color:#ffd1d1"|<code>AudioRes/Key.arc/enemy.prj</code> || style="background-color:#ffd1d1"|Leftover project information about the <code>.BAS</code> files.
|-
| <code>AudioRes/PSound.aaf</code> || [[AFF file|<code>.AAF</code> audio archive file]]. Integral file that contains information about all the available sound effects, waves, instrument banks + programs, and music. || Pikmin 2 Sound Modding Toolkit
|-
| <code>AudioRes/PSound.asn</code> || <code>.ASN</code> audio sound names. Contains a list of all SoundIDs, which reference a sequence from <code>se.bms</code>. || asn2csv
|-
| style="background-color:#ffffcc"|<code>AudioRes/Seqs/Seq.arc/</code> || style="background-color:#ffffcc"|[[Pikmin 2 BMS file list|<code>.BMS</code> binary music sequences]]. Contains sequenced music (akin to MIDI files). || flaaffy or JAIMaker
|-
| <code>AudioRes/Seqs/Seq.arc/se.bms</code> || Special <code>.BMS</code> file containing all sound effect sequences in the game. || p2setoolkit, flaaffy or JAIMaker
|-
| style="background-color:#ffffcc"|<code>AudioRes/Stream/</code> || style="background-color:#ffffcc"|[[AST file list|<code>.AST</code> audio streams.]] Contains streamed music (akin to WAV or MP3 files). || JATAST
|-
| style="background-color:#ffd1d1"|<code>banner/</code> || style="background-color:#ffd1d1"|Contains three different Gamecube banner images for ''Pikmin 2''. This folder is unused; depending on the region, one of these was copied and placed into the root directory as <code>opening.bnr</code> || pyisotools
|-
| style="background-color:#ffffcc"|<code>enemy/</code> || style="background-color:#ffffcc"|Enemy data. Also includes plants, hazards, and misc. objects.
|-
| style="background-color:#ffffcc"|<code>enemy/common/enemyCommon.szs/</code> || style="background-color:#ffffcc"|Models of the rocks used in petrification. || FinModelUtility, SuperBMD, RiiStudio
|-
| style="background-color:#ffffcc"|<code>enemy/data/</code> || style="background-color:#ffffcc"|Enemy models, <code>.BCA</code> animations, and textures. || FinModelUtility, SuperBMD (animations), RiiStudio, GameCube File Tools (for <code>.BTI</code> textures).
|-
| style="background-color:#ffffcc"|<code>enemy/parm/enemyParms.szs/</code> || style="background-color:#ffffcc"|[[Pikmin 2 enemy parameters|Parameters for enemy HP, damage, move speed, collisions, animations, and ultra-bitter petrification models]]. || Notepad++, Pikmin 2 Enemy Collision Tree Blender Addon, Pikmin 2 Enemy Bitter/Stoneinfo Blender Addon
|-
| <code>enemy/parm/enemyResList.txt</code> || List of enemy resource file paths. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>*gameConfig.ini</code> || style="background-color:#ffd1d1"|These were likely game configuration settings that changed how the game was compiled, to create special versions of ''Pikmin 2''. || Notepad++
|-
| style="background-color:#ffffcc"|<code>memoryCard/memoryCardHeader.szs/</code> || style="background-color:#ffffcc"|Memory card menu icons and banner images. || Wiimms Image Tool + Hex Editor
|-
| <code>message/font_*.szs/pikmin2main.bfn</code> || Font data and textures. || bfntoolkit + GameCube File Tools
|-
| <code>message/mesRes_*.szs/pikmin2.bmc</code> || Data for font coloring. || Hex Editor
|-
| <code>message/mesRes_*.szs/pikmin2.bmg</code> || [[BMG file]], all text strings and dialog in the game. || pikminBMG
|-
| style="background-color:#ffffcc"|<code>new_screen/</code> || style="background-color:#ffffcc"|[[BLO file|<code>.BLO</code>files]]: HUDs, interfaces, and menus, with all their resources like graphics and animations. || pyblo2-gui
|-
| <code>opening.bnr</code> || Gamecube banner image. || pyisotools
|-
| <code>pikmin2*P.MAP</code> || Symbol map. Text file that lists where every function and piece of data in the game's code is located and its name, and is used in-game by the crash handler for debugging purposes. The symbol map in retail versions of the game is unreadable. || Notepad++
|-
| style="background-color:#ffffcc"|<code>thp/</code> || style="background-color:#ffffcc"|[[THP file|<code>.THP</code>files]]. Pre-rendered videos. The .ini files control when text strings are loaded on top of the videos. || wiiflowthpvideoconverter, Notepad++ (for .ini files)
|-
| style="background-color:#ffd1d1"|<code>timeStamp*.txt</code> || style="background-color:#ffd1d1"|Build dates. "J", "P", and "U" likely represent the Japanese, PAL, and US versions. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/</code> || style="background-color:#ffffcc"|Masamichi Abe's folder, who was a director for the game.
|-
| style="background-color:#ffffcc"|<code>user/Abe/cave/</code> || style="background-color:#ffffcc"|[[Pikmin 2 cave lighting files|Lighting files for caves]]. || Drought Ender's Cave Creator, Notepad++
|-
| <code>user/Abe/item/barrelParms.txt</code> || Clog health parameter. || Notepad++
|-
| <code>user/Abe/item/bridgeParms.txt</code> || Bridge health parameter. || Notepad++
|-
| <code>user/Abe/item/fountainParms.txt</code> || Challenge Mode Geyser health parameter. || Notepad++
|-
| <code>user/Abe/item/plantParms.txt</code> || Burgeoning Spiderwort parameters. || Notepad++
|-
| <code>user/Abe/item/rockParms.txt</code> || Burgeoning Spiderwort mold parameters. || Notepad++
|-
| <code>user/Abe/item/TreasureParms.txt</code> || Buried treasure health parameters. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/map/</code> || style="background-color:#ffffcc"|Routes/pathing, [[Pikmin 2 area generator file|object generation]], [[Pikmin 2 map lighting files|day cycle lighting]], and settings for aboveground areas (including the test map and Piklopedia areas). || Gen & Route Editor, Notepad++ (for .txt files/.ini lighting)
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/</code> || style="background-color:#ffffcc"|All treasure models and their <code>.BCK</code> carrying animations, as well as parameters for all carriable objects. || FinModelUtility, SuperBMD (animations), RiiStudio, Notepad++ (for collision/parameters)
|-
| style="background-color:#ffd1d1"|<code>user/Abe/Pellet/*/carcass_config.txt</code> || style="background-color:#ffd1d1"|Unused enemy carcass parameters. The real parameters are in <code>/user/Abe/Pellet/*/pelletlist_*.szs</code>. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Abe/Pellet/*/item_config.txt</code> || style="background-color:#ffd1d1"|Unused Exploration Kit treasure parameters. The real parameters are in <code>/user/Abe/Pellet/*/pelletlist_*.szs</code>. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/item_texts.szs</code> || style="background-color:#ffffcc"|Collision parameters for the Exploration Kit treasures, and their animation file paths. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Abe/Pellet/*/otakara_config.txt</code> || style="background-color:#ffd1d1"|Unused treasure parameters. The real parameters are in <code>/user/Abe/Pellet/*/pelletlist_*.szs</code>. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/otakara_texts.szs</code> || style="background-color:#ffffcc"|Collision parameters for the treasures, and their animation file paths. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/pellet.szs/</code> || style="background-color:#ffffcc"|All numbered pellet models, their <code>.BCK</code> carrying animations, and <code>.BRK</code> files that control their color. || FinModelUtility, SuperBMD (animations), RiiStudio
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/pellet_texts.szs/</code> || style="background-color:#ffffcc"|Collision parameters for the numbered pellets, and their animation file paths. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/pelletlist_*.szs</code> || style="background-color:#ffffcc"|Carryable object parameters, including enemy carcasses, Spiderwort berries, treasures, Exploration Kit treasures, and the numbered pellets. Includes carry weights, pokos earned, seeds earned, and the depth treasures are buried. || Notepad++
|-
| <code>user/Abe/piki/naviParms.txt</code> || [[NaviParms|Leader parameters]], like speed and attack power. || Notepad++
|-
| <code>user/Abe/piki/pikiParms.txt</code> || [[PikiParms|Pikmin parameters]], like speed and attack power. || Notepad++
|-
| <code>user/Abe/stages.txt</code> || List of aboveground areas and parameters. || Notepad++
|-
| <code>user/Abe/time/time.ini</code> || Day cycle parameters, controlling the length of the day and the related events that occur. || Notepad++
|-
| <code>user/Abe/vs/stages.txt</code> || [[2-Player Battle stage parameters|List of 2-Player Battle stages and parameters]]. || Notepad++
|-
| <code>user/Abe/vs/vs_X_*.txt</code> || [[Cave fixed layout|Pre-determined layouts]] for the 2-Player Battle stages, listing the cave units they use and their locations. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/</code> || style="background-color:#ffffcc"|Yasushi Ebisawa's folder, who programmed the particle effects and title screen.
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/card_e_reader/</code> || style="background-color:#ffffcc"|<code>.DWN</code> files for the three e-Reader Pikmin minigames.
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/effect/</code> || style="background-color:#ffffcc"|<code>.JPC</code> [[Jsystem#JParticle|JParticle]] archive files. All of the game's used particles and effects. || jpc_conv, GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Ebisawa/testdata/</code> || style="background-color:#ffd1d1"|Unused menu files, e-Reader files, and title screen things. || FinModelUtility, SuperBMD (animations), RiiStudio, GameCube File Tools (for <code>.BTI</code> textures)
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/title/</code> || style="background-color:#ffffcc"|Models and <code>.BCK</code> animations for the title screen and enemies/Pikmin on it. || FinModelUtility, SuperBMD (animations), RiiStudio
|-
| <code>user/Ebisawa/title/title.szs/param/param_pikmin.txt</code> || [[Pikmin 2 title screen|Title screen Pikmin parameters]]. || Notepad++
|-
| <code>user/Ebisawa/title/title.szs/param/param_title.txt</code> || [[Pikmin 2 title screen|Title screen parameters]]. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Kando/</code> || style="background-color:#ffffcc"|Yuji Kando's folder, who programmed the Pikmin and other various systems.
|-
| <code>user/Kando/aiConstants.txt</code> || Some parameters for constants: gravity, Spiderwort berries needed to create 1 spray, amount needed to repay the debt, and "camera angle" (the Y-axis rotation for when you enter a stage). || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Kando/bridge/</code> || style="background-color:#ffd1d1"|Unused bridge models. || FinModelUtility, SuperBMD, RiiStudio, obj2grid (for the <code>.BIN</code> collision files), GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Kando/develop/</code> || style="background-color:#ffd1d1"|Leftover development tool resources, seemingly for a map editor, route/path manager, a [[Jsystem#J2DGraph|2D graphic]] tester, and animation tester, among other things. || FinModelUtility, SuperBMD, RiiStudio, GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Kando/effect/game.jpc</code> || style="background-color:#ffd1d1"|Unused <code>.JPC</code> [[Jsystem#JParticle|JParticle]] archive file with a bunch of particle effects. || jpc_conv, GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/effect/modeleffect.szs</code> || style="background-color:#ffffcc"|Onion beam model and <code>.BRK</code>/<code>.BTK</code> animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/maps/</code> || style="background-color:#ffffcc"|Models for aboveground/piklopedia areas, [[Pikmin 2 waterboxes|waterboxes]], and [https://www.pikminwiki.com/Pikmin_2_cave_generation#Backgrounds cave vrboxes]. || FinModelUtility, SuperBMD, RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffd1d1"|<code>user/Kando/mizu.bti</code> || style="background-color:#ffd1d1"|Unused texture. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/objects/</code> || style="background-color:#ffffcc"|Models and animations for some objects: clog, bridge, seesaw blocks, cave entrances, gates, nectar, geyser, Burgeoning Spiderwort mold, Pikmin head, Burgeoning Spiderwort, nectar rock, Ujadani, and nectar weed. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/onyon/</code> || style="background-color:#ffffcc"|Onion models and animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/piki/</code> || style="background-color:#ffffcc"|Model and animations for Pikmin, leaders, and the cursor + reticle. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/pod*/</code> || style="background-color:#ffffcc"|Research Pod model and animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffd1d1"|<code>user/Kando/resulttex/</code> || style="background-color:#ffd1d1"|Unused old Treasure Hoard icons, likely for cave/day end results. || GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Kando/texCaster/arc.szs/tex.bti</code> || style="background-color:#ffd1d1"|Unused texture. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/ufo*/</code> || style="background-color:#ffffcc"|Hocotate Ship model and animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/vstex/</code> || style="background-color:#ffffcc"|2-Player Battle Roulette icons and other minor HUD textures. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/zukan/</code> || style="background-color:#ffffcc"|Slightly simpler copy of the unused test map, with its own generation and lighting settings. || Gen & Route Editor (for routes/finding coords for [[Pikmin 2 waterboxes|waterboxes]]), Notepad++ (for .txt files/.ini lighting)
|-
|-
| style="background-color:#ffffcc"|<code>user/Koono/</code> || style="background-color:#ffffcc"|Hiroyuki Kono (Koono)'s folder, who programmed menus for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Koono/mail_icon.szs</code> || style="background-color:#ffffcc"|Space mail icons. || GameCube File Tools
|-
| <code>user/Koono/mail_table.szs/mail_table.bin</code> || IDs from the <code>.BMG</code> that correspond to each piece of [[mail]]. || Hex Editor
|-
| style="background-color:#ffffcc"|<code>user/Matoba/</code> || style="background-color:#ffffcc"|Taku Matoba's folder, who designed caves for ''Pikmin 2''.
|-
| <code>user/Matoba/challenge/stages.txt</code> || [[Pikmin 2 Challenge Mode settings|List of Challenge Mode stages and parameters]]. || Notepad++
|-
| <code>user/Matoba/challenge/kfes-stages.txt</code> || List of Challenge Mode stages and parameters, when the game is in KFes mode. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Matoba/resulttex/</code> || style="background-color:#ffffcc"|Treasure icons used in the Treasure Hoard and cave/day end results. || GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Morimura/</code> || style="background-color:#ffd1d1"|Naoya Morimura's leftover folder, who programmed the more complicated enemies for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Mukki/</code> || style="background-color:#ffffcc"|Yutaka Hiramuki's folder, who designed caves for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Mukki/mapunits/arc/</code> || style="background-color:#ffffcc"|[[Cave unit generation|Cave unit assets and data]]. Contains models, routes/pathfinding, and [[Pikmin 2 waterboxes|waterboxes]]. || FinModelUtility, SuperBMD, RiiStudio, obj2grid (for the <code>.BIN</code> collision files, Gen & Route Editor (for routes/finding coords for waterboxes), Notepad++ (for waterboxes), GameCube File Tools (for radar texture)
|-
| style="background-color:#ffffcc"|<code>user/Mukki/caveinfo/</code> || style="background-color:#ffffcc"|[[Cave generation parameters|Cave generation files]]. || Drought Ender's Cave Creator, Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Mukki/units/</code> || style="background-color:#ffffcc"|[[Cave unit definition file|Cave unit definition files]]. || Drought Ender's Cave Creator, Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Mukki/movie/</code> || style="background-color:#ffffcc"|[[STB file|<code>.STB</code> files]]. In-game cutscenes. || pikmin2-stb
|-
| style="background-color:#ffffcc"|<code>user/Nishimura/</code> || style="background-color:#ffffcc"|Katsushito Nishimura's folder, who programmed enemies and the levels for ''Pikmin 2''.
|-
| <code>user/Nishimura/Camera/caveCameraParms.txt</code> || [[Pikmin 2 camera parameters|Camera parameters]] when in caves. || Notepad++
|-
| <code>user/Nishimura/Camera/groundCameraParms.txt</code> || [[Pikmin 2 camera parameters|Camera parameters]] when aboveground. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/引きカメラcameraParms.txt</code> || style="background-color:#ffd1d1"|Unused [[Pikmin 2 camera parameters|camera parameters]].
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/撮影cameraParms.txt</code> || style="background-color:#ffd1d1"|Unused [[Pikmin 2 camera parameters|camera parameters]].
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/本物 groundCameraParms.txt</code> || style="background-color:#ffd1d1"|Unused [[Pikmin 2 camera parameters|camera parameters]].
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/本物caveCameraParms.txt</code> || style="background-color:#ffd1d1"|Unused [[Pikmin 2 camera parameters|camera parameters]].
|-
| <code>user/Nishimura/Rumble/rumbleData.txt</code> || Controller rumble time and power parameters. || Notepad++
|-
| <code>user/Nishimura/Rumble/rumbleParms.txt</code> || Controller rumble modifier for distant objects. || Notepad++
|-
| <code>user/Nishimura/Shadow/shadowParms.txt</code> || Shadow parameters. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Ogawa/</code> || style="background-color:#ffd1d1"|Yuzuru Ogawa's leftover folder, who programmed menus for ''Pikmin 2'',
|-
| style="background-color:#ffffcc"|<code>user/Totaka/</code> || style="background-color:#ffffcc"|Kazumi Totaka's folder, who directed the sound design and created some music and sound effects for ''Pikmin 2''.
|-
| <code>user/Totaka/BgmList.txt</code> || List of all [[Pikmin 2 BMS file list|<code>.BMS</code> sequences]] and volume settings for each. || Notepad++
|-
| <code>user/Totaka/BgmList_BgmTest.txt</code> || List of all [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] in the game, with a leftover developer comment about compiling cave songs. || Notepad++
|-
| <code>user/Totaka/BgmList_Forest.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for Awakening Wood cave sublevels. || Notepad++
|-
| <code>user/Totaka/BgmList_Last.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for Wistful Wild cave sublevels. || Notepad++
|-
| <code>user/Totaka/BgmList_Tutorial.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for Valley of Repose cave sublevels. || Notepad++
|-
| <code>user/Totaka/BgmList_Yakushima.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for Perplexing Pool cave sublevels. || Notepad++
|-
| <code>user/Totaka/ChallengeBgmList.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for all Challenge Mode cave sublevels. || Notepad++
|-
| <code>user/Totaka/StreamList.txt</code> || List of all [[AST file list|streams]], their ID, and volume settings. || Notepad++
|-
| <code>user/Totaka/trackMap_Cond_T.txt</code> || [[Trackmap parameters|Track mappings]] that apply to caveconc and new_XX's [[Pikmin 2 CND file list|<code>.CND</code> conductor files]]. The listed songs were written by Kazumi Totaka. || Notepad++
|-
| <code>user/Totaka/trackMap_Seq_T.txt</code> || [[Trackmap parameters|Track mappings]] that apply to caveglass and caverelax's [[Pikmin 2 BMS file list|<code>.BMS</code> sequences]]. The listed songs were written by Kazumi Totaka. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Wakai/</code> || style="background-color:#ffffcc"|Hajime Wakai's folder, who wrote music for ''Pikmin 2''.
|-
| <code>user/Wakai/trackMap_Cond_W.txt</code> || [[Trackmap parameters|Track mappings]] that apply to cavemetal and cavesoil [[Pikmin 2 CND file list|<code>.CND</code> conductor files]]. The listed songs were written by Hajime Wakai. || Notepad++
|-
| <code>user/Wakai/trackMap_Seq_W.txt</code> || [[Trackmap parameters|Track mappings]] that apply to a few of Hajime Wakai's [[Pikmin 2 BMS file list|<code>.BMS</code> sequences]].|| Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/</code> || style="background-color:#ffffcc"|Yoshikazu Yamashita's folder, who did system programming and programmed most of the enemies for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/arc/</code> || style="background-color:#ffffcc"|Boot screen textures. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/enemytex/</code> || style="background-color:#ffffcc"|Piklopedia icons. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/zukan/</code> || style="background-color:#ffffcc"|Piklopedia enemy appearance parameters and day cycle lighting parameters. || Notepad++
|-

[[Category:Pikmin 2]]
[[Category:Directory trees]]

Pikmin 2 directory tree

2024-05-09T13:01:08Z

Waffles: added some links

{{DISPLAYTITLE:''Pikmin 2'' directory tree}}
This article lists all folders and noteworthy files in ''Pikmin 2'', and recommended tools for viewing or modifying them. 
Yellow rows are folders, and red rows are unused files or folders with no effect on the game.

{{todo|Add links for everything.}}

{| class="wikitable sortable"
! Path || Details || Recommended Tool
|-
| style="background-color:#ffffcc"|<code>AudioRes/</code> || style="background-color:#ffffcc"|[[Jsystem#JAudio|JAudio]] resources. Contains data for music, instruments, and sound effects. || Pikmin 2 Sound Modding Toolkit
|-
| style="background-color:#ffffcc"|<code>AudioRes/Banks</code> || style="background-color:#ffffcc"|[[AW file|<code>.AW</code> wave scene files]]. Contain audio samples of instruments and sound effects for the instrument programs. || Pikmin 2 Sound Modding Toolkit
|-
| style="background-color:#ffd1d1"|<code>AudioRes/BgmList.txt</code> || style="background-color:#ffd1d1"|Early list of [[Pikmin 2 BMS file list|sequences]] and volume settings. The real <code>BgmList.txt</code> is in Totaka's folder. || Notepad++
|-
| style="background-color:#ffffcc"|<code>AudioRes/Conductor.arc/</code> || style="background-color:#ffffcc"|[[Pikmin 2 CND file list|<code>.CND</code> conductor files]]. Creates music for caves. || Hex Editor
|-
| style="background-color:#ffffcc"|<code>AudioRes/Key.arc/</code> || style="background-color:#ffffcc"|<code>.BAS</code> files, which link SoundIDs to enemy animations. || Hex Editor
|-
| style="background-color:#ffd1d1"|<code>AudioRes/Key.arc/enemy.prj</code> || style="background-color:#ffd1d1"|Leftover project information about the <code>.BAS</code> files.
|-
| <code>AudioRes/PSound.aaf</code> || [[AFF file|<code>.AAF</code> audio archive file]]. Integral file that contains information about all the available sound effects, waves, instrument banks + programs, and music. || Pikmin 2 Sound Modding Toolkit
|-
| <code>AudioRes/PSound.asn</code> || <code>.ASN</code> audio sound names. Contains a list of all SoundIDs, which reference a sequence from <code>se.bms</code>. || asn2csv
|-
| style="background-color:#ffffcc"|<code>AudioRes/Seqs/Seq.arc/</code> || style="background-color:#ffffcc"|[[Pikmin 2 BMS file list|<code>.BMS</code> binary music sequences]]. Contains sequenced music (akin to MIDI files). || flaaffy or JAIMaker
|-
| <code>AudioRes/Seqs/Seq.arc/se.bms</code> || Special <code>.BMS</code> file containing all sound effect sequences in the game. || p2setoolkit, flaaffy or JAIMaker
|-
| style="background-color:#ffffcc"|<code>AudioRes/Stream/</code> || style="background-color:#ffffcc"|[[AST file list|<code>.AST</code> audio streams.]] Contains streamed music (akin to WAV or MP3 files). || JATAST
|-
| style="background-color:#ffd1d1"|<code>banner/</code> || style="background-color:#ffd1d1"|Contains three different Gamecube banner images for ''Pikmin 2''. This folder is unused; depending on the region, one of these was copied and placed into the root directory as <code>opening.bnr</code> || pyisotools
|-
| style="background-color:#ffffcc"|<code>enemy/</code> || style="background-color:#ffffcc"|Enemy data. Also includes plants, hazards, and misc. objects.
|-
| style="background-color:#ffffcc"|<code>enemy/common/enemyCommon.szs/</code> || style="background-color:#ffffcc"|Models of the rocks used in petrification. || FinModelUtility, SuperBMD, RiiStudio
|-
| style="background-color:#ffffcc"|<code>enemy/data/</code> || style="background-color:#ffffcc"|Enemy models, <code>.BCA</code> animations, and textures. || FinModelUtility, SuperBMD (animations), RiiStudio, GameCube File Tools (for <code>.BTI</code> textures).
|-
| style="background-color:#ffffcc"|<code>enemy/parm/enemyParms.szs/</code> || style="background-color:#ffffcc"|[[Pikmin 2 enemy parameters|Parameters for enemy HP, damage, move speed, collisions, animations, and ultra-bitter petrification models]]. || Notepad++, Pikmin 2 Enemy Collision Tree Blender Addon, Pikmin 2 Enemy Bitter/Stoneinfo Blender Addon
|-
| <code>enemy/parm/enemyResList.txt</code> || List of enemy resource file paths. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>*gameConfig.ini</code> || style="background-color:#ffd1d1"|These were likely game configuration settings that changed how the game was compiled, to create special versions of ''Pikmin 2''. || Notepad++
|-
| style="background-color:#ffffcc"|<code>memoryCard/memoryCardHeader.szs/</code> || style="background-color:#ffffcc"|Memory card menu icons and banner images. || Wiimms Image Tool + Hex Editor
|-
| <code>message/font_*.szs/pikmin2main.bfn</code> || Font data and textures. || bfntoolkit + GameCube File Tools
|-
| <code>message/mesRes_*.szs/pikmin2.bmc</code> || Data for font coloring. || Hex Editor
|-
| <code>message/mesRes_*.szs/pikmin2.bmg</code> || [[BMG file]], all text strings and dialog in the game. || pikminBMG
|-
| style="background-color:#ffffcc"|<code>new_screen/</code> || style="background-color:#ffffcc"|[[BLO file|<code>.BLO</code>files]]: HUDs, interfaces, and menus, with all their resources like graphics and animations. || pyblo2-gui
|-
| <code>opening.bnr</code> || Gamecube banner image. || pyisotools
|-
| <code>pikmin2*P.MAP</code> || Symbol map. Text file that lists where every function and piece of data in the game's code is located and its name, and is used in-game by the crash handler for debugging purposes. The symbol map in retail versions of the game is unreadable. || Notepad++
|-
| style="background-color:#ffffcc"|<code>thp/</code> || style="background-color:#ffffcc"|[[THP file|<code>.THP</code>files]]. Pre-rendered videos. The .ini files control when text strings are loaded on top of the videos. || wiiflowthpvideoconverter, Notepad++ (for .ini files)
|-
| style="background-color:#ffd1d1"|<code>timeStamp*.txt</code> || style="background-color:#ffd1d1"|Build dates. "J", "P", and "U" likely represent the Japanese, PAL, and US versions. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/</code> || style="background-color:#ffffcc"|Masamichi Abe's folder, who was a director for the game.
|-
| style="background-color:#ffffcc"|<code>user/Abe/cave/</code> || style="background-color:#ffffcc"|[[Pikmin 2 cave lighting files|Lighting files for caves]]. || Drought Ender's Cave Creator, Notepad++
|-
| <code>user/Abe/item/barrelParms.txt</code> || Clog health parameter. || Notepad++
|-
| <code>user/Abe/item/bridgeParms.txt</code> || Bridge health parameter. || Notepad++
|-
| <code>user/Abe/item/fountainParms.txt</code> || Challenge Mode Geyser health parameter. || Notepad++
|-
| <code>user/Abe/item/plantParms.txt</code> || Burgeoning Spiderwort parameters. || Notepad++
|-
| <code>user/Abe/item/rockParms.txt</code> || Burgeoning Spiderwort mold parameters. || Notepad++
|-
| <code>user/Abe/item/TreasureParms.txt</code> || Buried treasure health parameters. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/map/</code> || style="background-color:#ffffcc"|Routes/pathing, [[Pikmin 2 area generator file|object generation]], [[Pikmin 2 map lighting files|day cycle lighting]], and settings for aboveground areas (including the test map and Piklopedia areas). || Gen & Route Editor, Notepad++ (for .txt files/.ini lighting)
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/</code> || style="background-color:#ffffcc"|All treasure models and their <code>.BCK</code> carrying animations, as well as parameters for all carriable objects. || FinModelUtility, SuperBMD (animations), RiiStudio, Notepad++ (for collision/parameters)
|-
| style="background-color:#ffd1d1"|<code>user/Abe/Pellet/*/carcass_config.txt</code> || style="background-color:#ffd1d1"|Unused enemy carcass parameters. The real parameters are in <code>/user/Abe/Pellet/*/pelletlist_*.szs</code>. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Abe/Pellet/*/item_config.txt</code> || style="background-color:#ffd1d1"|Unused Exploration Kit treasure parameters. The real parameters are in <code>/user/Abe/Pellet/*/pelletlist_*.szs</code>. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/item_texts.szs</code> || style="background-color:#ffffcc"|Collision parameters for the Exploration Kit treasures, and their animation file paths. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Abe/Pellet/*/otakara_config.txt</code> || style="background-color:#ffd1d1"|Unused treasure parameters. The real parameters are in <code>/user/Abe/Pellet/*/pelletlist_*.szs</code>. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/otakara_texts.szs</code> || style="background-color:#ffffcc"|Collision parameters for the treasures, and their animation file paths. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/pellet.szs/</code> || style="background-color:#ffffcc"|All numbered pellet models, their <code>.BCK</code> carrying animations, and <code>.BRK</code> files that control their color. || FinModelUtility, SuperBMD (animations), RiiStudio
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/pellet_texts.szs/</code> || style="background-color:#ffffcc"|Collision parameters for the numbered pellets, and their animation file paths. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/pelletlist_*.szs</code> || style="background-color:#ffffcc"|Carryable object parameters, including enemy carcasses, Spiderwort berries, treasures, Exploration Kit treasures, and the numbered pellets. Includes carry weights, pokos earned, seeds earned, and the depth treasures are buried. || Notepad++
|-
| <code>user/Abe/piki/naviParms.txt</code> || [[NaviParms|Leader parameters]], like speed and attack power. || Notepad++
|-
| <code>user/Abe/piki/pikiParms.txt</code> || [[PikiParms|Pikmin parameters]], like speed and attack power. || Notepad++
|-
| <code>user/Abe/stages.txt</code> || List of aboveground areas and parameters. || Notepad++
|-
| <code>user/Abe/time/time.ini</code> || Day cycle parameters, controlling the length of the day and the related events that occur. || Notepad++
|-
| <code>user/Abe/vs/stages.txt</code> || [[2-Player Battle stage parameters|List of 2-Player Battle stages and parameters]]. || Notepad++
|-
| <code>user/Abe/vs/vs_X_*.txt</code> || [[Cave fixed layout|Pre-determined layouts]] for the 2-Player Battle stages, listing the cave units they use and their locations. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/</code> || style="background-color:#ffffcc"|Yasushi Ebisawa's folder, who programmed the particle effects and title screen.
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/card_e_reader/</code> || style="background-color:#ffffcc"|<code>.DWN</code> files for the three e-Reader Pikmin minigames.
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/effect/</code> || style="background-color:#ffffcc"|<code>.JPC</code> [[Jsystem#JParticle|JParticle]] archive files. All of the game's used particles and effects. || jpc_conv, GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Ebisawa/testdata/</code> || style="background-color:#ffd1d1"|Unused menu files, e-Reader files, and title screen things. || FinModelUtility, SuperBMD (animations), RiiStudio, GameCube File Tools (for <code>.BTI</code> textures)
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/title/</code> || style="background-color:#ffffcc"|Models and <code>.BCK</code> animations for the title screen and enemies/Pikmin on it. || FinModelUtility, SuperBMD (animations), RiiStudio
|-
| <code>user/Ebisawa/title/title.szs/param/param_pikmin.txt</code> || [[Pikmin 2 title screen|Title screen Pikmin parameters]]. || Notepad++
|-
| <code>user/Ebisawa/title/title.szs/param/param_title.txt</code> || [[Pikmin 2 title screen|Title screen parameters]]. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Kando/</code> || style="background-color:#ffffcc"|Yuji Kando's folder, who programmed the Pikmin and other various systems.
|-
| <code>user/Kando/aiConstants.txt</code> || Some parameters for constants: gravity, Spiderwort berries needed to create 1 spray, amount needed to repay the debt, and "camera angle" (the Y-axis rotation for when you enter a stage). || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Kando/bridge/</code> || style="background-color:#ffd1d1"|Unused bridge models. || FinModelUtility, SuperBMD, RiiStudio, obj2grid (for the <code>.BIN</code> collision files), GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Kando/develop/</code> || style="background-color:#ffd1d1"|Leftover development tool resources, seemingly for a map editor, route/path manager, a [[Jsystem#J2DGraph|2D graphic]] tester, and animation tester, among other things. || FinModelUtility, SuperBMD, RiiStudio, GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Kando/effect/game.jpc</code> || style="background-color:#ffd1d1"|Unused <code>.JPC</code> [[Jsystem#JParticle|JParticle]] archive file with a bunch of particle effects. || jpc_conv, GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/effect/modeleffect.szs</code> || style="background-color:#ffffcc"|Onion beam model and <code>.BRK</code>/<code>.BTK</code> animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/maps/</code> || style="background-color:#ffffcc"|Models for aboveground/piklopedia areas, [[Pikmin 2 waterboxes|waterboxes]], and [https://www.pikminwiki.com/Pikmin_2_cave_generation#Backgrounds cave vrboxes]. || FinModelUtility, SuperBMD, RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffd1d1"|<code>user/Kando/mizu.bti</code> || style="background-color:#ffd1d1"|Unused texture. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/objects/</code> || style="background-color:#ffffcc"|Models and animations for some objects: clog, bridge, seesaw blocks, cave entrances, gates, nectar, geyser, Burgeoning Spiderwort mold, Pikmin head, Burgeoning Spiderwort, nectar rock, Ujadani, and nectar weed. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/onyon/</code> || style="background-color:#ffffcc"|Onion models and animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/piki/</code> || style="background-color:#ffffcc"|Model and animations for Pikmin, leaders, and the cursor + reticle. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/pod*/</code> || style="background-color:#ffffcc"|Research Pod model and animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffd1d1"|<code>user/Kando/resulttex/</code> || style="background-color:#ffd1d1"|Unused old Treasure Hoard icons, likely for cave/day end results. || GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Kando/texCaster/arc.szs/tex.bti</code> || style="background-color:#ffd1d1"|Unused texture. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/ufo*/</code> || style="background-color:#ffffcc"|Hocotate Ship model and animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/vstex/</code> || style="background-color:#ffffcc"|2-Player Battle Roulette icons and other minor HUD textures. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/zukan/</code> || style="background-color:#ffffcc"|Slightly simpler copy of the unused test map, with its own generation and lighting settings. || Gen & Route Editor (for routes/finding coords for [[Pikmin 2 waterboxes|waterboxes]]), Notepad++ (for .txt files/.ini lighting)
|-
|-
| style="background-color:#ffffcc"|<code>user/Koono/</code> || style="background-color:#ffffcc"|Hiroyuki Kono (Koono)'s folder, who programmed menus for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Koono/mail_icon.szs</code> || style="background-color:#ffffcc"|Space mail icons. || GameCube File Tools
|-
| <code>user/Koono/mail_table.szs/mail_table.bin</code> || IDs from the <code>.BMG</code> that correspond to each piece of [[mail]]. || Hex Editor
|-
| style="background-color:#ffffcc"|<code>user/Matoba/</code> || style="background-color:#ffffcc"|Taku Matoba's folder, who designed caves for ''Pikmin 2''.
|-
| <code>user/Matoba/challenge/stages.txt</code> || [[Pikmin 2 Challenge Mode settings|List of Challenge Mode stages and parameters]]. || Notepad++
|-
| <code>user/Matoba/challenge/kfes-stages.txt</code> || List of Challenge Mode stages and parameters, when the game is in KFes mode. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Matoba/resulttex/</code> || style="background-color:#ffffcc"|Treasure icons used in the Treasure Hoard and cave/day end results. || GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Morimura/</code> || style="background-color:#ffd1d1"|Naoya Morimura's leftover folder, who programmed the more complicated enemies for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Mukki/</code> || style="background-color:#ffffcc"|Yutaka Hiramuki's folder, who designed caves for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Mukki/mapunits/arc/</code> || style="background-color:#ffffcc"|[[Cave unit generation|Cave unit assets and data]]. Contains models, routes/pathfinding, and [[Pikmin 2 waterboxes|waterboxes]]. || FinModelUtility, SuperBMD, RiiStudio, obj2grid (for the <code>.BIN</code> collision files, Gen & Route Editor (for routes/finding coords for waterboxes), Notepad++ (for waterboxes), GameCube File Tools (for radar texture)
|-
| style="background-color:#ffffcc"|<code>user/Mukki/caveinfo/</code> || style="background-color:#ffffcc"|[[Cave generation parameters|Cave generation files]]. || Drought Ender's Cave Creator, Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Mukki/units/</code> || style="background-color:#ffffcc"|[[Cave unit definition file|Cave unit definition files]]. || Drought Ender's Cave Creator, Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Mukki/movie/</code> || style="background-color:#ffffcc"|[[STB file|<code>.STB</code> files]]. In-game cutscenes. || pikmin2-stb
|-
| style="background-color:#ffffcc"|<code>user/Nishimura/</code> || style="background-color:#ffffcc"|Katsushito Nishimura's folder, who programmed enemies and the levels for ''Pikmin 2''.
|-
| <code>user/Nishimura/Camera/caveCameraParms.txt</code> || [[Pikmin 2 camera parameters|Camera parameters]] when in caves. || Notepad++
|-
| <code>user/Nishimura/Camera/groundCameraParms.txt</code> || [[Pikmin 2 camera parameters|Camera parameters]] when aboveground. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/引きカメラcameraParms.txt</code> || style="background-color:#ffd1d1"|Unused [[Pikmin 2 camera parameters|camera parameters]].
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/撮影cameraParms.txt</code> || style="background-color:#ffd1d1"|Unused [[Pikmin 2 camera parameters|camera parameters]].
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/本物 groundCameraParms.txt</code> || style="background-color:#ffd1d1"|Unused [[Pikmin 2 camera parameters|camera parameters]].
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/本物caveCameraParms.txt</code> || style="background-color:#ffd1d1"|Unused [[Pikmin 2 camera parameters|camera parameters]].
|-
| <code>user/Nishimura/Rumble/rumbleData.txt</code> || Controller rumble time and power parameters. || Notepad++
|-
| <code>user/Nishimura/Rumble/rumbleParms.txt</code> || Controller rumble modifier for distant objects. || Notepad++
|-
| <code>user/Nishimura/Shadow/shadowParms.txt</code> || Shadow parameters. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Ogawa/</code> || style="background-color:#ffd1d1"|Yuzuru Ogawa's leftover folder, who programmed menus for ''Pikmin 2'',
|-
| style="background-color:#ffffcc"|<code>user/Totaka/</code> || style="background-color:#ffffcc"|Kazumi Totaka's folder, who directed the sound design and created some music and sound effects for ''Pikmin 2''.
|-
| <code>user/Totaka/BgmList.txt</code> || List of all [[Pikmin 2 BMS file list|<code>.BMS</code> sequences]] and volume settings for each. || Notepad++
|-
| <code>user/Totaka/BgmList_BgmTest.txt</code> || List of all [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] in the game, with a leftover developer comment about compiling cave songs. || Notepad++
|-
| <code>user/Totaka/BgmList_Forest.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for Awakening Wood cave sublevels. || Notepad++
|-
| <code>user/Totaka/BgmList_Last.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for Wistful Wild cave sublevels. || Notepad++
|-
| <code>user/Totaka/BgmList_Tutorial.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for Valley of Repose cave sublevels. || Notepad++
|-
| <code>user/Totaka/BgmList_Yakushima.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for Perplexing Pool cave sublevels. || Notepad++
|-
| <code>user/Totaka/ChallengeBgmList.txt</code> || List of [[Pikmin 2 CND file list|<code>.CND</code> conductor files]] to use for all Challenge Mode cave sublevels. || Notepad++
|-
| <code>user/Totaka/StreamList.txt</code> || List of all [[AST file list|streams]], their ID, and volume settings. || Notepad++
|-
| <code>user/Totaka/trackMap_Cond_T.txt</code> || Track mappings that apply to caveconc and new_XX's [[Pikmin 2 CND file list|<code>.CND</code> conductor files]]. The listed songs were written by Kazumi Totaka. || Notepad++
|-
| <code>user/Totaka/trackMap_Seq_T.txt</code> || Track mappings that apply to caveglass and caverelax's [[Pikmin 2 BMS file list|<code>.BMS</code> sequences]]. The listed songs were written by Kazumi Totaka. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Wakai/</code> || style="background-color:#ffffcc"|Hajime Wakai's folder, who wrote music for ''Pikmin 2''.
|-
| <code>user/Wakai/trackMap_Cond_W.txt</code> || Track mappings that apply to cavemetal and cavesoil [[Pikmin 2 CND file list|<code>.CND</code> conductor files]]. The listed songs were written by Hajime Wakai. || Notepad++
|-
| <code>user/Wakai/trackMap_Seq_W.txt</code> || Track mappings that apply to a few of Hajime Wakai's [[Pikmin 2 BMS file list|<code>.BMS</code> sequences]].|| Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/</code> || style="background-color:#ffffcc"|Yoshikazu Yamashita's folder, who did system programming and programmed most of the enemies for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/arc/</code> || style="background-color:#ffffcc"|Boot screen textures. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/enemytex/</code> || style="background-color:#ffffcc"|Piklopedia icons. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/zukan/</code> || style="background-color:#ffffcc"|Piklopedia enemy appearance parameters and day cycle lighting parameters. || Notepad++
|-

[[Category:Pikmin 2]]
[[Category:Directory trees]]

Pikmin 2 directory tree

2024-05-09T12:13:25Z

Waffles: Explained every folder and file. Todo: Links

{{DISPLAYTITLE:''Pikmin 2'' directory tree}}
This article lists all folders and noteworthy files in ''Pikmin 2'', and recommended tools for viewing or modifying them. 
Yellow rows are folders, and red rows are unused files or folders with no effect on the game.

{{todo|Add links for everything.}}

{| class="wikitable sortable"
! Path || Details || Recommended Tool
|-
| style="background-color:#ffffcc"|<code>AudioRes/</code> || style="background-color:#ffffcc"|JAudio resources. Contains data for music, instruments, and sound effects. || Pikmin 2 Sound Modding Toolkit
|-
| style="background-color:#ffffcc"|<code>AudioRes/Banks</code> || style="background-color:#ffffcc"|<code>.AW</code> wave scene files. Contain audio samples of instruments and sound effects for the instrument programs. || Pikmin 2 Sound Modding Toolkit
|-
| style="background-color:#ffd1d1"|<code>AudioRes/BgmList.txt</code> || style="background-color:#ffd1d1"|Early list of sequences and volume settings. The real <code>BgmList.txt</code> is in Totaka's folder. || Notepad++
|-
| style="background-color:#ffffcc"|<code>AudioRes/Conductor.arc/</code> || style="background-color:#ffffcc"|<code>.CND</code> conductor files. Creates music for caves. || Hex Editor
|-
| style="background-color:#ffffcc"|<code>AudioRes/Key.arc/</code> || style="background-color:#ffffcc"|<code>.BAS</code> files, which link SoundIDs to enemy animations. || Hex Editor
|-
| style="background-color:#ffd1d1"|<code>AudioRes/Key.arc/enemy.prj</code> || style="background-color:#ffd1d1"|Leftover project information about the <code>.BAS</code> files.
|-
| <code>AudioRes/PSound.aaf</code> || <code>.AAF</code> audio archive file. Integral file that contains information about all the available sound effects, waves, instrument banks + programs, and music. || Pikmin 2 Sound Modding Toolkit
|-
| <code>AudioRes/PSound.asn</code> || <code>.ASN</code> audio sound names. Contains a list of all SoundIDs, which reference a sequence from <code>se.bms</code>. || asn2csv
|-
| style="background-color:#ffffcc"|<code>AudioRes/Seqs/Seq.arc/</code> || style="background-color:#ffffcc"|<code>.BMS</code> binary music sequences. Contains sequenced music (akin to MIDI files). || flaaffy or JAIMaker
|-
| <code>AudioRes/Seqs/Seq.arc/se.bms</code> || Special <code>.BMS</code> file containing all sound effect sequences in the game. || p2setoolkit, flaaffy or JAIMaker
|-
| style="background-color:#ffffcc"|<code>AudioRes/Stream/</code> || style="background-color:#ffffcc"|<code>.AST</code> audio streams. Contains streamed music (akin to WAV or MP3 files). || JATAST
|-
| style="background-color:#ffd1d1"|<code>banner/</code> || style="background-color:#ffd1d1"|Contains three different Gamecube banner images for ''Pikmin 2''. This folder is unused; depending on the region, one of these was copied and placed into the root directory as <code>opening.bnr</code> || pyisotools
|-
| style="background-color:#ffffcc"|<code>enemy/</code> || style="background-color:#ffffcc"|Enemy data. Also includes plants, hazards, and misc. objects.
|-
| style="background-color:#ffffcc"|<code>enemy/common/enemyCommon.szs/</code> || style="background-color:#ffffcc"|Models of the rocks used in petrification. || FinModelUtility, SuperBMD, RiiStudio
|-
| style="background-color:#ffffcc"|<code>enemy/data/</code> || style="background-color:#ffffcc"|Enemy models, <code>.BCA</code> animations, and textures. || FinModelUtility, SuperBMD (animations), RiiStudio, GameCube File Tools (for <code>.BTI</code> textures).
|-
| style="background-color:#ffffcc"|<code>enemy/parm/enemyParms.szs/</code> || style="background-color:#ffffcc"|Parameters for enemy HP, damage, move speed, collisions, animations, ultra-bitter petrification models, and more. || Notepad++, Pikmin 2 Enemy Collision Tree Blender Addon, Pikmin 2 Enemy Bitter/Stoneinfo Blender Addon
|-
| <code>enemy/parm/enemyResList.txt</code> || List of enemy resource file paths. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>*gameConfig.ini</code> || style="background-color:#ffd1d1"|These were likely game configuration settings that changed how the game was compiled, to create special versions of ''Pikmin 2''. || Notepad++
|-
| style="background-color:#ffffcc"|<code>memoryCard/memoryCardHeader.szs/</code> || style="background-color:#ffffcc"|Memory card menu icons and banner images. || Wiimms Image Tool + Hex Editor
|-
| <code>message/font_*.szs/pikmin2main.bfn</code> || Font data and textures. || bfntoolkit + GameCube File Tools
|-
| <code>message/mesRes_*.szs/pikmin2.bmc</code> || Data for font coloring. || Hex Editor
|-
| <code>message/mesRes_*.szs/pikmin2.bmg</code> || All text strings and dialog in the game. || pikminBMG
|-
| style="background-color:#ffffcc"|<code>new_screen/</code> || style="background-color:#ffffcc"|<code>.BLO</code>files: HUDs, interfaces, and menus, with all their resources like graphics and animations. || pyblo2-gui
|-
| <code>opening.bnr</code> || Gamecube banner image. || pyisotools
|-
| <code>pikmin2*P.MAP</code> || Symbol map. Text file that lists where every function and piece of data in the game's code is located and its name, and is used in-game by the crash handler for debugging purposes. The symbol map in retail versions of the game is unreadable. || Notepad++
|-
| style="background-color:#ffffcc"|<code>thp/</code> || style="background-color:#ffffcc"|<code>.THP</code>files. Pre-rendered videos. The .ini files control when text strings are loaded on top of the videos. || wiiflowthpvideoconverter, Notepad++ (for .ini files)
|-
| style="background-color:#ffd1d1"|<code>timeStamp*.txt</code> || style="background-color:#ffd1d1"|Build dates. "J", "P", and "U" likely represent the Japanese, PAL, and US versions. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/</code> || style="background-color:#ffffcc"|Masamichi Abe's folder, who was a director for the game.
|-
| style="background-color:#ffffcc"|<code>user/Abe/cave/</code> || style="background-color:#ffffcc"|Lighting files for caves. || Drought Ender's Cave Creator, Notepad++
|-
| <code>user/Abe/item/barrelParms.txt</code> || Clog health parameter. || Notepad++
|-
| <code>user/Abe/item/bridgeParms.txt</code> || Bridge health parameter. || Notepad++
|-
| <code>user/Abe/item/fountainParms.txt</code> || Challenge Mode Geyser health parameter. || Notepad++
|-
| <code>user/Abe/item/plantParms.txt</code> || Burgeoning Spiderwort parameters. || Notepad++
|-
| <code>user/Abe/item/rockParms.txt</code> || Burgeoning Spiderwort mold parameters. || Notepad++
|-
| <code>user/Abe/item/TreasureParms.txt</code> || Buried treasure health parameters. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/map/</code> || style="background-color:#ffffcc"|Routes/pathing, object generation, and day cycle lighting, and settings for aboveground areas (including the test map and Piklopedia areas). || Gen & Route Editor, Notepad++ (for .txt files/.ini lighting)
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/</code> || style="background-color:#ffffcc"|All treasure models and their <code>.BCK</code> carrying animations, as well as parameters for all carriable objects. || FinModelUtility, SuperBMD (animations), RiiStudio, Notepad++ (for collision/parameters)
|-
| style="background-color:#ffd1d1"|<code>user/Abe/Pellet/*/carcass_config.txt</code> || style="background-color:#ffd1d1"|Unused enemy carcass parameters. The real parameters are in <code>/user/Abe/Pellet/*/pelletlist_*.szs</code>. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Abe/Pellet/*/item_config.txt</code> || style="background-color:#ffd1d1"|Unused Exploration Kit treasure parameters. The real parameters are in <code>/user/Abe/Pellet/*/pelletlist_*.szs</code>. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/item_texts.szs</code> || style="background-color:#ffffcc"|Collision parameters for the Exploration Kit treasures, and their animation file paths. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Abe/Pellet/*/otakara_config.txt</code> || style="background-color:#ffd1d1"|Unused treasure parameters. The real parameters are in <code>/user/Abe/Pellet/*/pelletlist_*.szs</code>. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/otakara_texts.szs</code> || style="background-color:#ffffcc"|Collision parameters for the treasures, and their animation file paths. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/pellet.szs/</code> || style="background-color:#ffffcc"|All numbered pellet models, their <code>.BCK</code> carrying animations, and <code>.BRK</code> files that control their color. || FinModelUtility, SuperBMD (animations), RiiStudio
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/pellet_texts.szs/</code> || style="background-color:#ffffcc"|Collision parameters for the numbered pellets, and their animation file paths. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Abe/Pellet/*/pelletlist_*.szs</code> || style="background-color:#ffffcc"|Carryable object parameters, including enemy carcasses, Spiderwort berries, treasures, Exploration Kit treasures, and the numbered pellets. || Notepad++
|-
| <code>user/Abe/piki/naviParms.txt</code> || Leader parameters, like speed and attack power. || Notepad++
|-
| <code>user/Abe/piki/pikiParms.txt</code> || Pikmin parameters, like speed and attack power. || Notepad++
|-
| <code>user/Abe/stages.txt</code> || List of aboveground areas and parameters. || Notepad++
|-
| <code>user/Abe/time/time.ini</code> || Day cycle parameters, controlling the length of the day and the related events that occur. || Notepad++
|-
| <code>user/Abe/vs/stages.txt</code> || List of 2-Player Battle stages and parameters. || Notepad++
|-
| <code>user/Abe/vs/vs_X_*.txt</code> || Pre-determined layouts for the 2-Player Battle stages, listing the cave units they use and their locations. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/</code> || style="background-color:#ffffcc"|Yasushi Ebisawa's folder, who programmed the particle effects and title screen.
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/card_e_reader/</code> || style="background-color:#ffffcc"|<code>.DWN</code> files for the three e-Reader Pikmin minigames.
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/effect/</code> || style="background-color:#ffffcc"|<code>.JPC</code> JParticle archive files. All of the game's used particles and effects. || jpc_conv, GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Ebisawa/testdata/</code> || style="background-color:#ffd1d1"|Unused menu files, e-Reader files, and title screen things. || FinModelUtility, SuperBMD (animations), RiiStudio, GameCube File Tools (for <code>.BTI</code> textures)
|-
| style="background-color:#ffffcc"|<code>user/Ebisawa/title/</code> || style="background-color:#ffffcc"|Models and <code>.BCK</code> animations for the title screen and enemies/Pikmin on it. || FinModelUtility, SuperBMD (animations), RiiStudio
|-
| <code>user/Ebisawa/title/title.szs/param/param_pikmin.txt</code> || Title screen Pikmin parameters. || Notepad++
|-
| <code>user/Ebisawa/title/title.szs/param/param_title.txt</code> || Title screen parameters. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Kando/</code> || style="background-color:#ffffcc"|Yuji Kando's folder, who programmed the Pikmin and other various systems.
|-
| <code>user/Kando/aiConstants.txt</code> || Some parameters for constants: gravity, Spiderwort berries needed to create 1 spray, amount needed to repay the debt, and "camera angle" (the Y-axis rotation for when you enter a stage). || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Kando/bridge/</code> || style="background-color:#ffd1d1"|Unused bridge models. || FinModelUtility, SuperBMD, RiiStudio, obj2grid (for the <code>.BIN</code> collision files), GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Kando/develop/</code> || style="background-color:#ffd1d1"|Leftover development tool resources, seemingly for a map editor, route/path manager, a J2DGraph 2D graphic tester, and animation tester, among other things. || FinModelUtility, SuperBMD, RiiStudio, GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Kando/effect/game.jpc</code> || style="background-color:#ffd1d1"|Unused <code>.JPC</code> JParticle archive file with a bunch of particle effects. || jpc_conv, GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/effect/modeleffect.szs</code> || style="background-color:#ffffcc"|Onion beam model and <code>.BRK</code>/<code>.BTK</code> animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/maps/</code> || style="background-color:#ffffcc"|Models for aboveground/piklopedia areas, waterboxes, and cave vrboxes. || FinModelUtility, SuperBMD, RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffd1d1"|<code>user/Kando/mizu.bti</code> || style="background-color:#ffd1d1"|Unused texture. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/objects/</code> || style="background-color:#ffffcc"|Models and animations for some objects: clog, bridge, seesaw blocks, cave entrances, gates, nectar, geyser, Burgeoning Spiderwort mold, Pikmin head, Burgeoning Spiderwort, nectar rock, Ujadani, and nectar weed. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/onyon/</code> || style="background-color:#ffffcc"|Onion models and animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/piki/</code> || style="background-color:#ffffcc"|Model and animations for Pikmin, leaders, and the cursor + reticle. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/pod*/</code> || style="background-color:#ffffcc"|Research Pod model and animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffd1d1"|<code>user/Kando/resulttex/</code> || style="background-color:#ffd1d1"|Unused old Treasure Hoard icons, likely for cave/day end results. || GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Kando/texCaster/arc.szs/tex.bti</code> || style="background-color:#ffd1d1"|Unused texture. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/ufo*/</code> || style="background-color:#ffffcc"|Hocotate Ship model and animations. || FinModelUtility, SuperBMD (animations), RiiStudio, obj2grid (for the <code>.BIN</code> collision files)
|-
| style="background-color:#ffffcc"|<code>user/Kando/vstex/</code> || style="background-color:#ffffcc"|2-Player Battle Roulette icons and other minor HUD textures. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Kando/zukan/</code> || style="background-color:#ffffcc"|Slightly simpler copy of the unused test map, with its own generation and lighting settings. || Gen & Route Editor (for routes/finding coords for waterboxes), Notepad++ (for .txt files/.ini lighting)
|-
|-
| style="background-color:#ffffcc"|<code>user/Koono/</code> || style="background-color:#ffffcc"|Hiroyuki Kono (Koono)'s folder, who programmed menus for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Koono/mail_icon.szs</code> || style="background-color:#ffffcc"|Space mail icons. || GameCube File Tools
|-
| <code>user/Koono/mail_table.szs/mail_table.bin</code> || IDs from the <code>.BMG</code> that correspond to each piece of mail. || Hex Editor
|-
| style="background-color:#ffffcc"|<code>user/Matoba/</code> || style="background-color:#ffffcc"|Taku Matoba's folder, who designed caves for ''Pikmin 2''.
|-
| <code>user/Matoba/challenge/stages.txt</code> || List of Challenge Mode stages and parameters. || Notepad++
|-
| <code>user/Matoba/challenge/kfes-stages.txt</code> || List of Challenge Mode stages and parameters, when the game is in KFes mode. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Matoba/resulttex/</code> || style="background-color:#ffffcc"|Treasure icons used in the Treasure Hoard and cave/day end results. || GameCube File Tools
|-
| style="background-color:#ffd1d1"|<code>user/Morimura/</code> || style="background-color:#ffd1d1"|Naoya Morimura's leftover folder, who programmed the more complicated enemies for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Mukki/</code> || style="background-color:#ffffcc"|Yutaka Hiramuki's folder, who designed caves for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Mukki/mapunits/arc/</code> || style="background-color:#ffffcc"|Cave unit models, routes/pathfinding, and waterboxes. || FinModelUtility, SuperBMD, RiiStudio, obj2grid (for the <code>.BIN</code> collision files, Gen & Route Editor (for routes/finding coords for waterboxes), Notepad++ (for waterboxes), GameCube File Tools (for radar texture)
|-
| style="background-color:#ffffcc"|<code>user/Mukki/caveinfo/</code> || style="background-color:#ffffcc"|Cave files. || Drought Ender's Cave Creator, Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Mukki/units/</code> || style="background-color:#ffffcc"|Cave unit list files. || Drought Ender's Cave Creator, Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Mukki/movie/</code> || style="background-color:#ffffcc"|<code>.STB</code> files. In-game cutscenes. || pikmin2-stb
|-
| style="background-color:#ffffcc"|<code>user/Nishimura/</code> || style="background-color:#ffffcc"|Katsushito Nishimura's folder, who programmed enemies and the levels for ''Pikmin 2''.
|-
| <code>user/Nishimura/Camera/caveCameraParms.txt</code> || Camera parameters when in caves. || Notepad++
|-
| <code>user/Nishimura/Camera/groundCameraParms.txt</code> || Camera parameters when aboveground. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/引きカメラcameraParms.txt</code> || style="background-color:#ffd1d1"|Unknown camera parameters.
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/撮影cameraParms.txt</code> || style="background-color:#ffd1d1"|Unknown camera parameters.
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/本物 groundCameraParms.txt</code> || style="background-color:#ffd1d1"|Unknown camera parameters.
|-
| style="background-color:#ffd1d1"|<code>user/Nishimura/Camera/本物caveCameraParms.txt</code> || style="background-color:#ffd1d1"|Unknown camera parameters.
|-
| <code>user/Nishimura/Rumble/rumbleData.txt</code> || Controller rumble time and power parameters. || Notepad++
|-
| <code>user/Nishimura/Rumble/rumbleParms.txt</code> || Controller rumble modifier for distant objects. || Notepad++
|-
| <code>user/Nishimura/Shadow/shadowParms.txt</code> || Shadow parameters. || Notepad++
|-
| style="background-color:#ffd1d1"|<code>user/Ogawa/</code> || style="background-color:#ffd1d1"|Yuzuru Ogawa's leftover folder, who programmed menus for ''Pikmin 2'',
|-
| style="background-color:#ffffcc"|<code>user/Totaka/</code> || style="background-color:#ffffcc"|Kazumi Totaka's folder, who directed the sound design and created some music and sound effects for ''Pikmin 2''.
|-
| <code>user/Totaka/BgmList.txt</code> || List of all <code>.BMS</code> sequences and volume settings for each. || Notepad++
|-
| <code>user/Totaka/BgmList_BgmTest.txt</code> || List of all <code>.CND</code> conductor files in the game, with a leftover developer comment about compiling cave songs. || Notepad++
|-
| <code>user/Totaka/BgmList_Forest.txt</code> || List of <code>.CND</code> conductor files to use for Awakening Wood cave sublevels. || Notepad++
|-
| <code>user/Totaka/BgmList_Last.txt</code> || List of <code>.CND</code> conductor files to use for Wistful Wild cave sublevels. || Notepad++
|-
| <code>user/Totaka/BgmList_Tutorial.txt</code> || List of <code>.CND</code> conductor files to use for Valley of Repose cave sublevels. || Notepad++
|-
| <code>user/Totaka/BgmList_Yakushima.txt</code> || List of <code>.CND</code> conductor files to use for Perplexing Pool cave sublevels. || Notepad++
|-
| <code>user/Totaka/ChallengeBgmList.txt</code> || List of <code>.CND</code> conductor files to use for all Challenge Mode cave sublevels. || Notepad++
|-
| <code>user/Totaka/StreamList.txt</code> || List of all streams, their ID, and volume settings. || Notepad++
|-
| <code>user/Totaka/trackMap_Cond_T.txt</code> || Track mappings that apply to caveconc and new_XX's <code>.CND</code> conductor files. The listed songs were written by Kazumi Totaka. || Notepad++
|-
| <code>user/Totaka/trackMap_Seq_T.txt</code> || Track mappings that apply to caveglass and caverelax's <code>.BMS</code> sequences. The listed songs were written by Kazumi Totaka. || Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Wakai/</code> || style="background-color:#ffffcc"|Hajime Wakai's folder, who wrote music for ''Pikmin 2''.
|-
| <code>user/Wakai/trackMap_Cond_W.txt</code> || Track mappings that apply to cavemetal and cavesoil <code>.CND</code> conductor files. The listed songs were written by Hajime Wakai. || Notepad++
|-
| <code>user/Wakai/trackMap_Seq_W.txt</code> || Track mappings that apply to a few of Hajime Wakai's <code>.BMS</code> sequences.|| Notepad++
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/</code> || style="background-color:#ffffcc"|Yoshikazu Yamashita's folder, who did system programming and programmed most of the enemies for ''Pikmin 2''.
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/arc/</code> || style="background-color:#ffffcc"|Boot screen textures. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/enemytex/</code> || style="background-color:#ffffcc"|Piklopedia icons. || GameCube File Tools
|-
| style="background-color:#ffffcc"|<code>user/Yamashita/zukan/</code> || style="background-color:#ffffcc"|Piklopedia enemy and used lighting parameters. || Notepad++
|-

[[Category:Pikmin 2]]
[[Category:Directory trees]]

Creating cave music

2024-04-19T14:03:39Z

Waffles: Improvements

Randomly generating cave music in Pikmin 2 needs to have two files: a .bms (sequence) file, and a .cnd (conductor) file.

The BMS file type is a sequenced music format used in many games. For the cave music in Pikmin 2 however, it is specially-formatted. It mainly contains many short snippets of musical information to be randomized.

The CND files are the actual "songs"; they take specific groups of snippets from a BMS file, and endlessly puzzle-piece them together to form a coherent piece of music.

This guide will function as a walkthrough for creating your own randomly sequencing cave song. Basic understanding of how [https://youtube.com/watch?v=QPFWzSlg-78 cave music works] and [[Creating Interactive BMS Files|standard interactive music]] is recommended before starting. Most of the editing will be done in hexadecimal.

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be generating a lot of tiny BMS files, to turn them into "gestures".
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

Additionally, studying the existing cave songs on your own and how those exploit the conductor system in interesting ways will help you come up with ideas for your own custom cave music.

== Overview of file functions ==
Here are some infographics that you can reference at any time. These show all the functions of a CND file, and all the contents of a BMS file.
<gallery mode="packed-hover" widths=250px heights=250px>
File:CND_functions.png|Conductor file functions.
File:BMS_functions.png|How information is stored in a BMS file.
</gallery>

== Setting up your BMS file ==
Before you begin, set your byte grouping to "3", so every 3 bytes is visually separated by a space. This will make it easier to see stuff. 
Starting with a completely blank BMS file, begin by pasting the following:
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600
</source>
Every cave music BMS begins with this same information, and will go mostly untouched.
 
 

== Gesture set list ==
Exactly right after <code>34C600</code> will be a list of every gesture set's location in the BMS. Each entry is the gesture set's hexadecimal location (offset), and each entry in the sequence begins with "<code>00</code>". <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0001B0 0001BF 0001CE 0001D4 0001DA 0001E9 0001F8 0001FE 000204 00020A FFFFFF</code> 
Gesture set "0" will be at offset <code>0x1B0</code>, gesture set "1" will be at offset <code>0x1BF</code>, gesture set "2" will be at <code>0x1CE</code>, and so on. There are a total of 10 gesture sets listed in the above sequence.
 
Until we create our gesture sets, let's use <code>00AAAA</code> as placeholders so we can easily find and get back to this section later on. You can have as many gesture sets as you like; we'll create 16 entries for this tutorial. You may insert this into your BMS: 
<code>00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF</code> 
 
Our BMS should now currently look like this: 
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000
</source>
You can also add an entire row of padding/zeros after this. You can do this for each section, to better visually separate them.
 

== Timing ruleset list ==
This is another sequence of offsets. These just point to the location of a "[[#Inserting_timetables|timetable]]", which will be located at the end of our BMS file. <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0005AB 0005AB 0005AF 0005C1 0005AB 0005AB 0005C1 0005C1 0005C1 0005C1 FFFFFF</code> 
Timing ruleset "0" will use the timetable at <code>0x5AB</code>, timing ruleset "1" will also use the timetable at <code>0x5AB</code>, timing ruleset "2" will use the timetable at <code>0x5AF</code>, and so on. There are a total of 10 timing rulesets listed in the above sequence.
 
Let's use <code>00BBBB</code> as placeholders again, and create 16 of them. Insert this anywhere into your BMS: 
<code>00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB FFFFFF</code> 
 

== Gesture set contents ==
A ''gesture set'' is a group of many gestures. 
Here, we list each gesture set's contents (which will be... the locations of the gestures!). Each gesture set begins before with <code>00</code> and ends with <code>FFFFFF</code>. 
Here is an example of how the gesture set list should be formatted: 
<code>000210 00022A 000258 000281 FFFFFF 0002B4 0002D9 000303 000331 FFFFFF 000355 FFFFFF 000361 FFFFFF 0003A8 0003C2 0003F0 000419 FFFFFF 00044C 000471 00049B 0004C9 FFFFFF 0004ED FFFFFF 000543 FFFFFF 000580 FFFFFF 00059E FFFFFF</code> 
There are 10 gesture sets listed above. The first gesture set has 4 gestures, located at <code>0x210</code>, <code>0x22A</code>, <code>0x258</code>, and <code>0x281</code>. You can have any amount of gestures in a gesture set; even 1 is fine.
 
You can paste the following placeholder information for now: 
<code>00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC FFFFFF</code> 
It might be a good idea to leave a decent amount of zeros after this list; this one will expand a lot as gestures and gesture sets are added to it.
 

== How is your BMS looking? ==
If you have been copy-pasting everything correctly, your BMS will look something like this:
<gallery mode="packed-hover" widths=300px heights=300px>
File:BMS_file_progress_1.png|Orange is "gesture set list", yellow is "timing ruleset list", and blue is "gesture set contents"
</gallery>
Once again, you can add as much padding between each section as you want, it will work fine.

== Creating gestures ==
First, you should sketch out your song idea in your DAW, and then cut your song into tiny blocks. These blocks will be your song's individual gestures. You should also consider dragging these blocks around in various arrangements to make sure they sound good in any order. 
Once you are ready, have them nicely organized and ready to be exported into individual MIDI files:
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_Pro_gestures.png|A Logic Pro project with a bunch of short blocks of music. Each block will be a "gesture".
</gallery>
For some reason, imported BMS files play 4 times as slow in cave songs. So if you import these gestures as is, they will play 4 times as slow. 
Before you export your gestures, you need to modify your gestures to run ''4 times as fast''. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each block.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>

== Inserting gestures ==
Gestures use same the note/music information as standard BMS songs. 

You should have converted all your MIDIs into BMS files. Open up one of your converted BMS files, and look for the first note/pitch value. If you used [[Pikmin 2 custom music|flaaffy]], this will most likely be somewhere after <code>0x1B</code>, <code>0x1C</code>, or <code>0x1D</code>. The note's pitch value will often be followed by a <code>01</code>, then the velocity value. Copy this note, all the way to the end of the sequence, which should be <code>FF</code>.
<gallery mode="packed-hover" widths=600px>
File:Copy_pasting_BMS_info.png|The value "2D" here is the hex value of a certain pitch, and the very first note of the sequence. Copy this, all the way to "FF".
</gallery>
To add your gesture, start it with <code>C40000015D</code>, then paste in what you copied. Each gesture should end with that <code>FF</code>. Add as many gestures as you please!
<gallery mode="packed-hover" widths=400px heights=400px>
File:BMS_file_progress_2.png|The purple lines indicate where a gesture starts.
</gallery>

== Inserting timetables ==
So, how do we choose how often gestures will play? Will a gesture play every beat? Every 1/2 a beat? You will need to add a timetable for that!
A timetable is a sequence that dictates when gestures should play. A timetable ends with <code>FFFF</code>. You can make a timetable as complex as you like. Some examples of timetables you can use are: 
* <code>0780 FFFF</code> Play a gesture every 16 beats. 
* <code>03C0 FFFF</code> Play a gesture every 8 beats. 
* <code>01E0 FFFF</code> Play a gesture every 4 beats. 
* <code>03C0 03C0 03C0 01E0 01E0 01E0 01E0 03C0 FFFF</code> This sequence will play a gesture every 8 beats (3x), play a gesture every 4 beats (4x), then play a gesture for 8 beats (1x), in that order. 
* <code>00F0 FFFF</code> Play a gesture every 1/2 note (every 2 beats). 
* <code>0078 FFFF</code> Play a gesture every 1/4 note (every beat). 
* <code>003C FFFF</code> Play a gesture every 1/8th note. 
* <code>001E FFFF</code> Play a gesture every 1/16th note. 
* <code>003C 0078 001E FFFF</code> This sequence will play a gesture for an 1/8th note, play a gesture for a 1/4 note, then play a gesture for a 1/16th note, in that order. 
Considering that <code>001E</code> (30 in decimal) is a 1/16th note, you can create any specific timing you want. Just add another 30 to the value for each additional sixteenth note in length. 
For example, Soil 1's enemy mix piano plays a gesture every three sixteenth notes. That would be 90 in decimal, and its timetable would look like <code>005A FFFF</code>. 
You can insert your timetables anywhere at the end of your BMS.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_3.png|Each timetable has a pink box around it.
</gallery>

== Filling in info ==
Once you have your gestures and timetables inserted, go back and fill in those <code>00AAAA</code>, <code>00BBBB</code>, <code>00CCCC</code> placeholders with the locations of your gesture sets, timetables, and gestures you want to use. Remember that gesture sets begin with the <code>00</code>.

Also in the very beginning of your BMS, make sure the value at <code>0x6</code> has the location of where your gesture set list begins (this one will probably be fine), and the value at <code>0x14</code> has the location of where your timing ruleset list begins.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_4.png|Put the location of where the "timing ruleset list" begins here.
</gallery>

== Filling in the conductor file ==
<gallery mode="packed-hover" widths=500px heights=500px>
File:CND_functions.png|Conductor file functions.
</gallery>
In your song's associated conductor file, try to stretch out the window so that the instrument names are all in the same column if you can, like in the image above. 
Each line represents one track. You give each track a instrument (program), and what gesture set and timing ruleset to use. 
The CND infographic above does a good job explaining all the functions, but they'll be explained again down here. 

In the top left corner are three important values:
* The first value is the swing time. <code>1E</code> is 1/16th swing, while <code>3C</code> is 1/8th swing. If your song is below 100bpm, you might want to use <code>1E</code>. If its faster, try <code>3C</code> instead.
* The second value is the tempo, in hex.
* The third value is how many tracks there will be, in hex.

Each column explained:
* A: Initial delay. How many beats until this track starts running. In the vanilla game, you can notice how some song's melodies do not immediately begin playing upon the start of level. This is useful for that; ease the listener into the music.
* B/Q: If set to 1, all gestures will be delayed by an 1/8th note..
* C: Text string. You can make this say whatever you like. Useful for keeping track of what you want each track to be, like "Lead", "Trumpet", "MelodyA"/"MelodyB", "Bass", or "Drums"
* D: Track copy. Select a previous track # to copy the gestures from. If the track its copying plays "gesture 3" from its gesture set, this track will also play its "gesture 3". Often used for treasure mix instruments. You can have them use different gesture sets if you like.
* E: Echo strength.
* F: If set to 1, the values in this track's timetable will always be played in order, in a loop. If set to 0, it will randomly select values from its timetable, thus, allowing you to randomize when gestures play.
* G: Bank number.
* H: Program number. For a list of all programs in the default game and the wScenes that support them, view [[Pikmin 2 custom_music/available instruments|this page]].
* I: Gesture set, select the set # you want to use from the BMS.
* J: Timing ruleset, select the set # you want to use from the BMS.
* K: How many gestures this track will play, before playing "silent gestures". Linked to below. These function as a sort of on/off cycle.
* L: How many "silent gestures" this track will play, before playing normal gestures. Linked to above. These function as a sort of on/off cycle.
* M: If notes are being transposed down (see below), this is set to FF. But this column doesn't actually do anything, so you don't need to edit this.
* N: Transpose all notes played by this track. To transpose up, use values 1-127. To transpose down, use the sign 2 compliment (values 128-255).
* O: Volume.
* P: Stereo panning.
 
Some ideas/considerations:
* You can use the on/off cycle feature (column K and L) to make your melodic instrument "take a break" every once in a while. You can have it play 4 gestures, but then be silent for 2.
* If your timing ruleset is strict (as in, the timings for when gestures occur is always consistent), something fun to try is to have the melody be a back-and-forth between two different instruments. Set the initial delay for the second instrument to be longer than the first one, and then cleverly use the on/off cycle to have the instruments take turns sounding a gesture. This is done for the melody in the Bulblax Kingdom and Frontier Cavern for example.
* If you are using the "track copy" feature (column D), you can have the primary instrument play a melody, and have this instrument always play chords that perfectly match that melody.

== Mapping the tracks ==
With all that done, don't forget to edit the song's [[Trackmap parameters|trackMap]]! Edit your song in the trackMap files in either <code>/user/Totaka</code> or <code>/user/Wakai</code>, and set how many instruments will be in each mix. It goes in order from: Main Mix, Task (event), Treasure (otakara), Enemy near (kehai), Combat mix, and Spiderwort mix (ground). Although you cannot find Spiderworts underground, you will have to sacrifice at least one track for that mix. You cannot set any of the mixes to have 0 instruments in them.

== Bonus: Filenames for brand new CND files ==
If you are adding a brand new CND file instead of replacing an existing one, the prefix will determine which BMS is loaded, and which wScene. Try not to add special characters to filenames, aside from underscores. 

In order to load the correct BMS file, the CND must start with the name of the BMS file.
* "caveconc.cnd", "caveconc_458435.cnd", "caveconc_Waffles.cnd", and "caveconc_Waffles_Song_2.cnd" will all load caveconc.bms. 
* "caverelax.cnd", "caverelax_Gmajor.cnd", and "caverelax_mamuta_dinner.cnd" will all load caverelax.bms. 
* "new_09_4.cnd", "new_09_4000.cnd", and "new_09_portal_PotaTOS.cnd" will load new_09.bms. 

For cavesoil, caveconc, and cavemetal only, the game also checks for an additional "_00", "_05", and "_10" right after the prefix, for the purpose of loading one of three different wScenes. You must include it if you want the correct wScene to load. For example, caveconc_05 loads wScene 31, so if you want your custom song to also load wScene 31, acceptable names include "caveconc_05_WAFFLES.cnd", "caveconc_05_52_46356.cnd", or "caveconc_05_super_boss.cnd". 

After adding your new CND file, be sure to add it to its respective trackMap file.

== Bonus: Adding new content to a vanilla BMS file ==
Adding new hex data in the middle of a file will shift all the offsets that come after it, causing your BMS to jump to the wrong locations, and likely cause a crash if vanilla songs are loaded. 
In order to add new content in addition to what's already in the BMS:
* Find and copy the gesture set list and the timing ruleset list, and paste them at the end of the file. (Separate them with lots of zeros so you have lots more space to add content to these lists)
* Change <code>0x6</code> and <code>0x14</code> to point to your new gesture set list and timing ruleset list. These two values tell the game where the lists are.
The game should now use these brand new lists, instead of the original instances that occur earlier in the file. Since they still contain all the locations of the vanilla gesture sets/timetables from above in the same order, the existing CND songs won't be affected and will continue to function, but now you can expand upon these lists with brand new entries now that you've made the space for them. All new gestures, gesture sets and timetables can be added further down the file.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Editing_vanilla_BMS_file.png|The new gesture set list and timing ruleset list we want to use will be at the bottom.
</gallery>

== Bonus: Adding gesture cutoffs in timetables ==
An intentional compositional choice in some songs is to cutoff gestures while they're in the middle of playing. The most common way this is done is to quickly trigger another gesture; if the last gesture has not finished playing, it will stop playing that gesture and begin playing the new one. It's also possible to add "empty" gestures to gesture sets (like <code>C40000015DFF</code>, a gesture which ends immediately and plays nothing), so you can randomly interrupt gestures in your song with silence, or have there be a chance to play nothing. 
However, if you wish to interrupt gestures in your song at specified times without the randomness, there is a special function in timetables for doing this. In the vanilla game, this is used for the trumpet in [https://www.youtube.com/watch?v=qOhmS1YLpF8 Fire]. The trumpet plays two interrupted gestures, then plays a third gesture in full. Below is the timetable for this trumpet: 
<code>0078 8168 81E0 00F0 80F0 81E0 0780 FFFF</code> 
The trumpet will:
* <code>0078</code> play a gesture for 1 beat
* <code>8168</code> cutoff after this 1 beat
* <code>81E0</code> extend the silence for another 4 beats
* <code>00F0</code> play a gesture for 2 beats
* <code>80F0</code> cutoff after these 2 beats
* <code>81E0</code> extend the silence for another 4 beats
* <code>0780</code> play a gesture for 16 beats. 
In order to put a "cutoff" in your timetable:
* Start with how long you want your "playing" gesture to play for, before it gets cutoff. I want the the first gesture to last for one beat (four 1/16th notes), so I'll put <code>0078</code>. Remember that every "30" in decimal is equivalent to a sixteenth note.
* Immediately next in the sequence will be a value that indicates when the cutoff begins. Calculate the difference between "81E0" and the previous value you had just inserted. 81E0 - 0078 = 8168 (in decimal, 33248 - 120 = 33128). I will put <code>8168</code> next in my sequence.
My sequence is now <code>0078 8168 FFFF</code>; this will play a gesture normally for 1 beat, but then immediately cut it off after that 1 beat. 
Putting an additional <code>81E0</code> in the sequence right after will extend the silence for another 4 beats if you so desire. You can keep putting <code>81E0</code> right after several times in a row if you want silence to last extra long until the next gesture plays.

[[Category:Pikmin 2]]

Creating Interactive BMS Files

2024-04-18T16:53:41Z

Waffles: /* Missing/dropped notes */

This guide will function as a walkthrough for creating interactive music for Pikmin 2's main areas. 

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be exporting each track of your MIDI separately as its own BMS file, and importing them one at a time.
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

Most of the editing will be done in hexadecimal. Creating [[Creating cave music|cave music]] is very similar.

== Preparing and exporting MIDIs ==
You will be exporting each track of your song as its own separate MIDI file, and then convert each MIDI into a mini BMS file of its own. 
If your song has 14 instruments, then you'll export 14 MIDIs. Make sure each track is the same length so that looping will work properly. 

For some reason, imported BMS files play exactly 4 times as slow in interactive music. So if you import the tracks as is, they will play 4 times as slow. 
Before you export them, you need to modify them to run 4 times as fast. Do not address this by changing the BPM in your DAW, you need to shorten the actual regions instead. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each entire track.
<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial5.png|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>
(Note: While you *can* technically just multiply the BPM value by 4 in the BMS later on, Louie's variant is dependent on the BPM being something normal, so the swing will not be applied properly if you do that.)

== Base BMS file ==
Starting from scratch, here is a base for you to work off of. In a hex editor, copy and paste this into a completely new, blank BMS file:
<pre>E74000A0 0003AC04 0104AA20 050400B1 C1400005 AC04010A AA200504 00B1C140 0105AC04 0110AA20 050400B1 C1400205 AC040116 AA200504 00B1C140 0305AC04 011CAA20 050400B1 C1400405 AC040122 AA200504 00B1C140 0505AC04 0128AA20 050400B1 C1400605 AC04012E AA200504 00B1C140 0705AC04 0134AA20 050400B1 C1400805 AC04013A AA200504 00B1C140 0905AC04 0140AA20 050400B1 C1400A05 AC040146 AA200504 00B1C140 0B05AC04 014CAA20 050400B1 C1400C05 AC040152 AA200504 00B1C140 0D05AC04 0158AA20 050400B1 C1400E05 AC04015E AA200504 00B1C140 0F05FE00 78FD0066 C8000001 9F884B00 C8000000 E9884B00 C8000000 F98001FF 0002AA00 071E0002 E600075A 00032200 07960003 5E0007D2 00039A00 080E0003 D600084A 00041200 08860004 4E0008C2 00048A00 08FE0004 C600093A 00050200 09760005 3E0009B2 00057A00 09EE0005 B6000A2A 0005F200 0A660006 2E000AA2 C600E70E 00DF0700 018AE72E 00CF03C8 0000016E E70E00DF 0700018A E72E00CF 03C80000 0180E71E 00E3E700 00E70F00 DF070001 9BC600E7 1F00E3E7 0E00DF07 0001B9E7 4001C805 000000E7 2E00CF03 C8000001 A7E71E00 E74001C8 050001C5 E3E1C800 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 44617920 76657273 696F6E3A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000042 00004900 00560000 50000000 00000000 00000000 5365713A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000294C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0002D0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00030CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000348C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000384C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0003C0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0003FCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000438C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000474C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0004B0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0004ECC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000528C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000564C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0005A0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0005DCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000618C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 53756E73 65742076 65722E3A 00000020 20202000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000042 00004900 00560000 50000000 00000000 00000000 5365713A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000708C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000744C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000780C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0007BCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0007F8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000834C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000870C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008ACC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008E8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000924C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000960C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00099CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0009D8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000A14C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000A50C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00058CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 FF000000 3C2D2028 4E756C6C 20747261 636B2061 74203078 30623034 2C20666F 7220616E 7920656D 70747920 74726163 6B732900 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 76767620 50617374 6520796F 75722073 65717565 6E636573 20686572 65212076 76760000 00000000 00000000 00000000 00000000 00000000 00000000</pre>

This file is setup with all the important information already filled out for you. You should resize the window so that you can see all 16 Day tracks and all 16 Sunset tracks evenly spaced on each line:

<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial1.png|You can use this image as a guide for the "mixer".
</gallery>

This section is sort of like a mixer; you can set the volume and stereo panning of each track. More importantly, you also choose the bank and program here. Most importantly, at the end of each track, you select what sequence the track uses. You just type in the offset of the sequence there.

== Importing sequences ==
=== Converting ===
Convert all your MIDIs into BMS files with [[Pikmin 2 custom music|flaaffy]]. You can use the following commands in the command line (make sure to include the "-loop" argument in the first command, so it knows to loop the sequence):

<pre>mareep.exe mareep -errand jolt -input exampletrack02.midi -output exampletrack02.txt -loop
mareep.exe mareep -errand cotton -input exampletrack02.txt -output exampletrack02.bms</pre>

Flaaffy turns the MIDI into a text file before it is converted into a BMS. The text file is "cotton", flaaffy's assembly language. Viewing the cotton file can be useful for double checking there's in fact only one track in each of your MIDIs. You will open each BMS file you make with flaaffy, and copy paste the hex data of each into the bottom of the Base BMS.

=== Copying and pasting ===
In your exported BMS, look for the instance of <code>A420</code> (if there are multiple, use the last occurrence of it). This A420 is what sets the bank of the sequence, and it will be followed by either a 00, 01, 02, 03, 04, or 05 after it. 

If you want to use bank 0, change it to <code>A42000</code>, if you want to use bank 4, change it to <code>A42004</code>, and so on. 

Copy <code>A420</code> and the entire remainder of the file, and paste everything into your Base BMS, anywhere at the bottom of it.

<gallery mode="packed-hover" widths=160px heights=160px>
File:InteractiveBMStutorial2.png|This is what you should copy. If your track has a lot of notes in it, this can be much longer.
</gallery>

<gallery mode="packed-hover" widths=220px heights=220px>
File:InteractiveBMStutorial3.png|This is how you should paste in the sequences.
</gallery>

You should paste each converted BMS on a new line, separated by an empty line of zeros so its easy to tell where each sequence begins.

=== Looping ===
Notice the <code>C80000XXXX</code> at the very end of the sequence you pasted in (the C80000 will be the same, but the numbers at the end will be different). The "XXXX" tells the sequence where the song loops and should restart at. Change XXXX to be where the sequence starts in the base BMS file. (Ex: do <code>C8000011D4</code> if the sequence starts at 0x11D4).

== Finishing touches ==
=== Fill in the mixer ===
After you have imported all the sequences, have made sure all the <code>A420</code>'s have the right bank, and looped them, go back to the Base BMS mixer and fill in the appropriate information. (Bank, program, volume, panning, sequence location.) The "sequence location" will be the offset where each <code>A420</code> is.

(Note: You do not have to import the same sequence over and over again if there are any identical sequences; you are free to reference the same one sequence and just give them different instruments. This is useful for sunset versions or treasure mix instruments.)

=== Null track ===
If you don't want a track to play anything, have it go to the "null track" located at <code>0B04</code>. (If you look, it's just a single "FF", which is a sequence that ends immediately.) This is what each track is set to by default in the provided Base BMS.

=== Tempo ===
You don't have to touch anything in the header at the top of the Base BMS, except for changing the BPM. The BPM for your song is located at 0xEA and takes up two bytes. (Ex: "<code>0066</code>" for 102 BPM).

=== Padding ===
Add in an extra line of zeros or two at the end of your finished Base BMS, because it sometimes crashes if extra padding is not there.

=== trackMap ===
Make sure the tracks in the Base BMS mixer go in order: Main -> Task -> Treasure -> Enemy near -> Battle -> Spiderwort. Same for the sunset version. 
Open the sequence trackMap in <code>/user/Wakai/</code>, find the song you are replacing (forest.bms, last.bms...), and [[Trackmap parameters|edit the values in the trackMap]] to reflect how many instruments will be in each mix. The main and sunset version will use the same mapping. You can make unnecessary tracks silent in the Base BMS's mixer if your sunset version has less instruments.

== Troubleshooting ==
=== Tracks not looping correctly ===
Make sure each track is exactly the same length. You can export your entire song as one MIDI, convert it to BMS, and import it into the game as an un-interactive BMS file just to check. Flaaffy is finicky with looping occasionally; you may need to add a note at the end or start of a track so flaaffy knows thats the definitive start/end point of that track. (Make the note very quiet, low-pitch, and or short so its practically inaudible.)

=== Tracks not looping at all ===
Double-check you added the -loop argument in flaaffy. Test with an un-interactive BMS file. Make sure there isn't any stray information somewhere in your MIDI.

=== Volume/panning/program settings not working ===
It is possible there is volume automation, panning automation, or program changes somewhere in your MIDI/BMS you have imported. This is something you can add intentionally if you really want to (like changing the program for a track in the middle of the song), but it will override the values you put in the Base BMS mixer.

=== Track not playing at all===
The most common cause of this is accidentally setting the wrong bank.

=== Missing/dropped notes ===
This is an another issue with flaaffy. If a "Note On" also occurs at the same time a "Note Off" of the same pitch does, or multiple "Note On"s occur at the exact same millisecond, flaaffy's BMS won't render those notes. You might run into this often when instruments try to play chords. 

The simple fix for flaaffy is to make sure notes of the same pitch do not touch each other (put a tiny bit of empty space between them), and to slightly skew/slant each note in chords.

<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial4.png|Make sure the notes in a chord don't occur at the same time.
</gallery>

Alternatively, JAIMaker does not run into this issue for its BMS conversions. If you decide to use it instead, you will need to be more precise about importing the data from the BMS files into the Base BMS.

Creating Interactive BMS Files

2024-04-18T12:21:20Z

Waffles: Slight fix

This guide will function as a walkthrough for creating interactive music for Pikmin 2's main areas. 

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be exporting each track of your MIDI separately as its own BMS file, and importing them one at a time.
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

Most of the editing will be done in hexadecimal. Creating [[Creating cave music|cave music]] is very similar.

== Preparing and exporting MIDIs ==
You will be exporting each track of your song as its own separate MIDI file, and then convert each MIDI into a mini BMS file of its own. 
If your song has 14 instruments, then you'll export 14 MIDIs. Make sure each track is the same length so that looping will work properly. 

For some reason, imported BMS files play exactly 4 times as slow in interactive music. So if you import the tracks as is, they will play 4 times as slow. 
Before you export them, you need to modify them to run 4 times as fast. Do not address this by changing the BPM in your DAW, you need to shorten the actual regions instead. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each entire track.
<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial5.png|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>
(Note: While you *can* technically just multiply the BPM value by 4 in the BMS later on, Louie's variant is dependent on the BPM being something normal, so the swing will not be applied properly if you do that.)

== Base BMS file ==
Starting from scratch, here is a base for you to work off of. In a hex editor, copy and paste this into a completely new, blank BMS file:
<pre>E74000A0 0003AC04 0104AA20 050400B1 C1400005 AC04010A AA200504 00B1C140 0105AC04 0110AA20 050400B1 C1400205 AC040116 AA200504 00B1C140 0305AC04 011CAA20 050400B1 C1400405 AC040122 AA200504 00B1C140 0505AC04 0128AA20 050400B1 C1400605 AC04012E AA200504 00B1C140 0705AC04 0134AA20 050400B1 C1400805 AC04013A AA200504 00B1C140 0905AC04 0140AA20 050400B1 C1400A05 AC040146 AA200504 00B1C140 0B05AC04 014CAA20 050400B1 C1400C05 AC040152 AA200504 00B1C140 0D05AC04 0158AA20 050400B1 C1400E05 AC04015E AA200504 00B1C140 0F05FE00 78FD0066 C8000001 9F884B00 C8000000 E9884B00 C8000000 F98001FF 0002AA00 071E0002 E600075A 00032200 07960003 5E0007D2 00039A00 080E0003 D600084A 00041200 08860004 4E0008C2 00048A00 08FE0004 C600093A 00050200 09760005 3E0009B2 00057A00 09EE0005 B6000A2A 0005F200 0A660006 2E000AA2 C600E70E 00DF0700 018AE72E 00CF03C8 0000016E E70E00DF 0700018A E72E00CF 03C80000 0180E71E 00E3E700 00E70F00 DF070001 9BC600E7 1F00E3E7 0E00DF07 0001B9E7 4001C805 000000E7 2E00CF03 C8000001 A7E71E00 E74001C8 050001C5 E3E1C800 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 44617920 76657273 696F6E3A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000042 00004900 00560000 50000000 00000000 00000000 5365713A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000294C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0002D0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00030CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000348C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000384C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0003C0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0003FCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000438C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000474C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0004B0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0004ECC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000528C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000564C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0005A0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0005DCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000618C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 53756E73 65742076 65722E3A 00000020 20202000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000042 00004900 00560000 50000000 00000000 00000000 5365713A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000708C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000744C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000780C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0007BCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0007F8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000834C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000870C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008ACC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008E8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000924C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000960C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00099CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0009D8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000A14C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000A50C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00058CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 FF000000 3C2D2028 4E756C6C 20747261 636B2061 74203078 30623034 2C20666F 7220616E 7920656D 70747920 74726163 6B732900 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 76767620 50617374 6520796F 75722073 65717565 6E636573 20686572 65212076 76760000 00000000 00000000 00000000 00000000 00000000 00000000</pre>

This file is setup with all the important information already filled out for you. You should resize the window so that you can see all 16 Day tracks and all 16 Sunset tracks evenly spaced on each line:

<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial1.png|You can use this image as a guide for the "mixer".
</gallery>

This section is sort of like a mixer; you can set the volume and stereo panning of each track. More importantly, you also choose the bank and program here. Most importantly, at the end of each track, you select what sequence the track uses. You just type in the offset of the sequence there.

== Importing sequences ==
=== Converting ===
Convert all your MIDIs into BMS files with [[Pikmin 2 custom music|flaaffy]]. You can use the following commands in the command line (make sure to include the "-loop" argument in the first command, so it knows to loop the sequence):

<pre>mareep.exe mareep -errand jolt -input exampletrack02.midi -output exampletrack02.txt -loop
mareep.exe mareep -errand cotton -input exampletrack02.txt -output exampletrack02.bms</pre>

Flaaffy turns the MIDI into a text file before it is converted into a BMS. The text file is "cotton", flaaffy's assembly language. Viewing the cotton file can be useful for double checking there's in fact only one track in each of your MIDIs. You will open each BMS file you make with flaaffy, and copy paste the hex data of each into the bottom of the Base BMS.

=== Copying and pasting ===
In your exported BMS, look for the instance of <code>A420</code> (if there are multiple, use the last occurrence of it). This A420 is what sets the bank of the sequence, and it will be followed by either a 00, 01, 02, 03, 04, or 05 after it. 

If you want to use bank 0, change it to <code>A42000</code>, if you want to use bank 4, change it to <code>A42004</code>, and so on. 

Copy <code>A420</code> and the entire remainder of the file, and paste everything into your Base BMS, anywhere at the bottom of it.

<gallery mode="packed-hover" widths=160px heights=160px>
File:InteractiveBMStutorial2.png|This is what you should copy. If your track has a lot of notes in it, this can be much longer.
</gallery>

<gallery mode="packed-hover" widths=220px heights=220px>
File:InteractiveBMStutorial3.png|This is how you should paste in the sequences.
</gallery>

You should paste each converted BMS on a new line, separated by an empty line of zeros so its easy to tell where each sequence begins.

=== Looping ===
Notice the <code>C80000XXXX</code> at the very end of the sequence you pasted in (the C80000 will be the same, but the numbers at the end will be different). The "XXXX" tells the sequence where the song loops and should restart at. Change XXXX to be where the sequence starts in the base BMS file. (Ex: do <code>C8000011D4</code> if the sequence starts at 0x11D4).

== Finishing touches ==
=== Fill in the mixer ===
After you have imported all the sequences, have made sure all the <code>A420</code>'s have the right bank, and looped them, go back to the Base BMS mixer and fill in the appropriate information. (Bank, program, volume, panning, sequence location.) The "sequence location" will be the offset where each <code>A420</code> is.

(Note: You do not have to import the same sequence over and over again if there are any identical sequences; you are free to reference the same one sequence and just give them different instruments. This is useful for sunset versions or treasure mix instruments.)

=== Null track ===
If you don't want a track to play anything, have it go to the "null track" located at <code>0B04</code>. (If you look, it's just a single "FF", which is a sequence that ends immediately.) This is what each track is set to by default in the provided Base BMS.

=== Tempo ===
You don't have to touch anything in the header at the top of the Base BMS, except for changing the BPM. The BPM for your song is located at 0xEA and takes up two bytes. (Ex: "<code>0066</code>" for 102 BPM).

=== Padding ===
Add in an extra line of zeros or two at the end of your finished Base BMS, because it sometimes crashes if extra padding is not there.

=== trackMap ===
Make sure the tracks in the Base BMS mixer go in order: Main -> Task -> Treasure -> Enemy near -> Battle -> Spiderwort. Same for the sunset version. 
Open the sequence trackMap in <code>/user/Wakai/</code>, find the song you are replacing (forest.bms, last.bms...), and [[Trackmap parameters|edit the values in the trackMap]] to reflect how many instruments will be in each mix. The main and sunset version will use the same mapping. You can make unnecessary tracks silent in the Base BMS's mixer if your sunset version has less instruments.

== Troubleshooting ==
=== Tracks not looping correctly ===
Make sure each track is exactly the same length. You can export your entire song as one MIDI, convert it to BMS, and import it into the game as an un-interactive BMS file just to check. Flaaffy is finicky with looping occasionally; you may need to add a note at the end or start of a track so flaaffy knows thats the definitive start/end point of that track. (Make the note very quiet, low-pitch, and or short so its practically inaudible.)

=== Tracks not looping at all ===
Double-check you added the -loop argument in flaaffy. Test with an un-interactive BMS file. Make sure there isn't any stray information somewhere in your MIDI.

=== Volume/panning/program settings not working ===
It is possible there is volume automation, panning automation, or program changes somewhere in your MIDI/BMS you have imported. This is something you can add intentionally if you really want to (like changing the program for a track in the middle of the song), but it will override the values you put in the Base BMS mixer.

=== Track not playing at all===
The most common cause of this is accidentally setting the wrong bank.

=== Missing/dropped notes ===
This is an another issue with flaaffy. If a "Note On" also occurs at the same time a "Note Off" does, or multiple "Note On"s occur at the exact same millisecond, flaaffy's BMS won't render those notes. You might run into this often when instruments try to play chords. 

The simple fix for flaaffy is to make sure notes of the same pitch do not touch each other (put a tiny bit of empty space between them), and to slightly skew/slant each note in chords.

<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial4.png|Make sure the notes in a chord don't occur at the same time.
</gallery>

Alternatively, JAIMaker does not run into this issue for its BMS conversions. If you decide to use it instead, you will need to be more precise about importing the data from the BMS files into the Base BMS.

Creating cave music

2024-04-18T09:12:12Z

Waffles:

Randomly generating cave music in Pikmin 2 needs to have two files: a .bms (sequence) file, and a .cnd (conductor) file.

The BMS file type is a sequenced music format used in many games. For the cave music in Pikmin 2 however, it is specially-formatted. It mainly contains many short snippets of musical information to be randomized.

The CND files are the actual "songs"; they take specific groups of snippets from a BMS file, and endlessly puzzle-piece them together to form a coherent piece of music.

This guide will function as a walkthrough for creating your own randomly sequencing cave song. All of the editing will be done in hexadecimal.

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be generating a lot of tiny BMS files, to turn them into "gestures".
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

Basic understanding of how [https://youtube.com/watch?v=QPFWzSlg-78 cave music works] and the [[Creating Interactive BMS Files|standard interactive music]] is recommended before starting. Additionally, studying the existing cave songs on your own and how those exploit the conductor system in interesting ways can greatly help you come up with ideas for your own custom music.

== Overview of file functions ==
Here are some infographics that you can reference at any time. These show all the functions of a CND file, and all the contents of a BMS file.
<gallery mode="packed-hover" widths=250px heights=250px>
File:CND_functions.png|Conductor file functions.
File:BMS_functions.png|How information is stored in a BMS file.
</gallery>

== Setting up your BMS file ==
Before you begin, set your byte grouping to "3", so every 3 bytes is visually separated by a space. This will make it easier to see stuff. 
Starting with a completely blank BMS file, begin by pasting the following:
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600
</source>
Every cave music BMS begins with this same information, and will go mostly untouched.
 
 

== Gesture set list ==
Exactly right after <code>34C600</code> will be a list of every gesture set's location in the BMS. Each entry is the gesture set's hexadecimal location (offset), and each entry in the sequence begins with "<code>00</code>". <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0001B0 0001BF 0001CE 0001D4 0001DA 0001E9 0001F8 0001FE 000204 00020A FFFFFF</code> 
Gesture set "0" will be at offset <code>0x1B0</code>, gesture set "1" will be at offset <code>0x1BF</code>, gesture set "2" will be at <code>0x1CE</code>, and so on. There are a total of 10 gesture sets listed in the above sequence.
 
Until we create our gesture sets, let's use <code>00AAAA</code> as placeholders so we can easily find and get back to this section later on. You can have as many gesture sets as you like; we'll create 16 entries for this tutorial. You may insert this into your BMS: 
<code>00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF</code> 
 
Our BMS should now currently look like this: 
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000
</source>
You can also add an entire row of padding/zeros after this. You can do this for each section, to better visually separate them.
 

== Timing ruleset list ==
This is another sequence of offsets. These just point to the location of a "[[#Inserting_timetables|timetable]]", which will be located at the end of our BMS file. <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0005AB 0005AB 0005AF 0005C1 0005AB 0005AB 0005C1 0005C1 0005C1 0005C1 FFFFFF</code> 
Timing ruleset "0" will use the timetable at <code>0x5AB</code>, timing ruleset "1" will also use the timetable at <code>0x5AB</code>, timing ruleset "2" will use the timetable at <code>0x5AF</code>, and so on. There are a total of 10 timing rulesets listed in the above sequence.
 
Let's use <code>00BBBB</code> as placeholders again, and create 16 of them. Insert this anywhere into your BMS: 
<code>00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB FFFFFF</code> 
 

== Gesture set contents ==
A ''gesture set'' is a group of many gestures. 
Here, we list each gesture set's contents (which will be... the locations of the gestures!). Each gesture set begins before with <code>00</code> and ends with <code>FFFFFF</code>. 
Here is an example of how the gesture set list should be formatted: 
<code>000210 00022A 000258 000281 FFFFFF 0002B4 0002D9 000303 000331 FFFFFF 000355 FFFFFF 000361 FFFFFF 0003A8 0003C2 0003F0 000419 FFFFFF 00044C 000471 00049B 0004C9 FFFFFF 0004ED FFFFFF 000543 FFFFFF 000580 FFFFFF 00059E FFFFFF</code> 
There are 10 gesture sets listed above. The first gesture set has 4 gestures, located at <code>0x210</code>, <code>0x22A</code>, <code>0x258</code>, and <code>0x281</code>. You can have any amount of gestures in a gesture set; even 1 is fine.
 
You can paste the following placeholder information for now: 
<code>00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC FFFFFF</code> 
It might be a good idea to leave a decent amount of zeros after this list; this one will expand a lot as gestures and gesture sets are added to it.
 

== How is your BMS looking? ==
If you have been copy-pasting everything correctly, your BMS will look something like this:
<gallery mode="packed-hover" widths=300px heights=300px>
File:BMS_file_progress_1.png|Orange is "gesture set list", yellow is "timing ruleset list", and blue is "gesture set contents"
</gallery>
Once again, you can add as much padding between each section as you want, it will work fine.

== Creating gestures ==
First, you should sketch out your song idea in your DAW, and then cut your song into tiny blocks. These blocks will be your song's individual gestures. You should also consider dragging these blocks around in various arrangements to make sure they sound good in any order. 
Once you are ready, have them nicely organized and ready to be exported into individual MIDI files:
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_Pro_gestures.png|A Logic Pro project with a bunch of short blocks of music. Each block will be a "gesture".
</gallery>
For some reason, imported BMS files play 4 times as slow in cave songs. So if you import these gestures as is, they will play 4 times as slow. 
Before you export your gestures, you need to modify your gestures to run ''4 times as fast''. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each block.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>

== Inserting gestures ==
Gestures use same the note/music information as standard BMS songs. 

You should have converted all your MIDIs into BMS files. Open up one of your converted BMS files, and look for the first note/pitch value. If you used [[Pikmin 2 custom music|flaaffy]], this will most likely be somewhere after <code>0x1B</code>, <code>0x1C</code>, or <code>0x1D</code>. The note's pitch value will often be followed by a <code>01</code>, then the velocity value. Copy this note, all the way to the end of the sequence, which should be <code>FF</code>.
<gallery mode="packed-hover" widths=600px>
File:Copy_pasting_BMS_info.png|The value "2D" here is the hex value of a certain pitch, and the very first note of the sequence. Copy this, all the way to "FF".
</gallery>
To add your gesture, start it with <code>C40000015D</code>, then paste in what you copied. Each gesture should end with that <code>FF</code>. Add as many gestures as you please!
<gallery mode="packed-hover" widths=400px heights=400px>
File:BMS_file_progress_2.png|The purple lines indicate where a gesture starts.
</gallery>

== Inserting timetables ==
So, how do we choose how often gestures will play? Will a gesture play every beat? Every 1/2 a beat? You will need to add a timetable for that!
A timetable is a sequence that dictates when gestures should play. A timetable ends with <code>FFFF</code>. You can make a timetable as complex as you like. Some examples of timetables you can use are: 
* <code>0780FFFF</code> Play a gesture every 16 beats. 
* <code>03C0FFFF</code> Play a gesture every 8 beats. 
* <code>01E0FFFF</code> Play a gesture every 4 beats. 
* <code>03C003C003C001E001E001E001E003C0FFFF</code> This sequence will play a gesture every 8 beats (3x), play a gesture every 4 beats (4x), then play a gesture for 8 beats (1x), in that order. 
* <code>00F0FFFF</code> Play a gesture every 1/2 note (every 2 beats). 
* <code>0078FFFF</code> Play a gesture every 1/4 note (every beat). 
* <code>003CFFFF</code> Play a gesture every 1/8th note. 
* <code>001EFFFF</code> Play a gesture every 1/16th note. 
* <code>003C0078001EFFFF</code> This sequence will play a gesture for an 1/8th note, play a gesture for a 1/4 note, then play a gesture for a 1/16th note, in that order. 
Considering that <code>001E</code> (30 in decimal) is a 1/16th note, you can create any specific timing you want. Just add another 30 to the value for each additional sixteenth note in length. 
For example, Soil 1's enemy mix piano plays very rapidly; its timetable uses a value of 90, which looks like <code>005AFFFF</code>. The gestures last for three sixteenth notes. 
You can insert your timetables anywhere at the end of your BMS.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_3.png|Each timetable has a pink box around it.
</gallery>

== Filling in info ==
Once you have your gestures and timetables inserted, go back and fill in those <code>00AAAA</code>, <code>00BBBB</code>, <code>00CCCC</code> placeholders with the locations of your gesture sets, timetables, and gestures you want to use. Remember that gesture sets begin with the <code>00</code>.

Also in the very beginning of your BMS, make sure the value at <code>0x6</code> has the location of where your gesture set list begins (this one will probably be fine), and the value at <code>0x14</code> has the location of where your timing ruleset list begins.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_4.png|Put the location of where the "timing ruleset list" begins here.
</gallery>

== Filling in the conductor file ==
<gallery mode="packed-hover" widths=500px heights=500px>
File:CND_functions.png|Conductor file functions.
</gallery>
In your song's associated conductor file, try to stretch out the window so that the instrument names are all in the same column if you can, like in the image above. 
Each line represents one track. You give each track a instrument (program), and what gesture set and timing ruleset to use. 
The CND infographic above does a good job explaining all the functions, but they'll be explained again down here. 

In the top left corner are three important values:
* The first value is the swing time. <code>1E</code> is 1/16th swing, while <code>3C</code> is 1/8th swing. If your song is below 100bpm, you might want to use <code>1E</code>. If its faster, try <code>3C</code> instead.
* The second value is the tempo, in hex.
* The third value is how many tracks there will be, in hex.

Each column explained:
* A: Initial delay. How many beats until this track starts running. In the vanilla game, you can notice how some song's melodies do not immediately begin playing upon the start of level. This is useful for that; ease the listener into the music.
* B/Q: If set to 1, all gestures will be delayed by an 1/8th note..
* C: Text string. You can make this say whatever you like. Useful for keeping track of what you want each track to be, like "Lead", "Trumpet", "MelodyA"/"MelodyB", "Bass", or "Drums"
* D: Track copy. Select a previous track # to copy the gestures from. If the track its copying plays "gesture 3" from its gesture set, this track will also play its "gesture 3". Often used for treasure mix instruments. You can have them use different gesture sets if you like.
* E: Echo strength.
* F: If set to 1, the values in this track's timetable will always be played in order, in a loop. If set to 0, it will randomly select values from its timetable, thus, allowing you to randomize when gestures play.
* G: Bank number.
* H: Program number. For a list of all programs in the default game and the wScenes that support them, view [[Pikmin 2 custom_music/available instruments|this page]].
* I: Gesture set, select the set # you want to use from the BMS.
* J: Timing ruleset, select the set # you want to use from the BMS.
* K: How many gestures this track will play, before playing "silent gestures". Linked to below. These function as a sort of on/off cycle.
* L: How many "silent gestures" this track will play, before playing normal gestures. Linked to above. These function as a sort of on/off cycle.
* M: If notes are being transposed down (see below), this is set to FF. But this column doesn't actually do anything, so you don't need to edit this.
* N: Transpose all notes played by this track. To transpose up, use values 1-127. To transpose down, use the sign 2 compliment (values 128-255).
* O: Volume.
* P: Stereo panning.
 
Some ideas/considerations:
* You can use the on/off cycle feature (column K and L) to make your melodic instrument "take a break" every once in a while. You can have it play 4 gestures, but then be silent for 2.
* If your timing ruleset is strict (as in, the timings for when gestures occur is always consistent), something fun to try is to have the melody be a back-and-forth between two different instruments. Set the initial delay for the second instrument to be longer than the first one, and then cleverly use the on/off cycle to have the instruments take turns sounding a gesture. This is done for the melody in the Bulblax Kingdom and Frontier Cavern for example.
* If you are using the "track copy" feature (column D), you can have the primary instrument play a melody, and have this instrument always play chords that perfectly match that melody.

== Mapping the tracks ==
With all that done, don't forget to edit the song's [[Trackmap parameters|trackMap]]! Edit your song in the trackMap files in either <code>/user/Totaka</code> or <code>/user/Wakai</code>, and set how many instruments will be in each mix. It goes in order from: Main Mix, Task (event), Treasure (otakara), Enemy near (kehai), Combat mix, and Spiderwort mix (ground). Although you cannot find Spiderworts underground, you will have to sacrifice at least one track for that mix. You cannot set any of the mixes to have 0 instruments in them.

== Bonus: Filenames for brand new CND files ==
If you are adding a brand new CND file instead of replacing an existing one, the prefix will determine which BMS is loaded, and which wScene. Try not to add special characters to filenames, aside from underscores. 

In order to load the correct BMS file, the CND must start with the name of the BMS file.
* "caveconc.cnd", "caveconc_458435.cnd", "caveconc_Waffles.cnd", and "caveconc_Waffles_Song_2.cnd" will all load caveconc.bms. 
* "caverelax.cnd", "caverelax_Gmajor.cnd", and "caverelax_mamuta_dinner.cnd" will all load caverelax.bms. 
* "new_09_4.cnd", "new_09_4000.cnd", and "new_09_portal_PotaTOS.cnd" will load new_09.bms. 

For cavesoil, caveconc, and cavemetal only, the game also checks for an additional "_00", "_05", and "_10" right after the prefix, for the purpose of loading one of three different wScenes. You must include it if you want the correct wScene to load. For example, caveconc_05 loads wScene 31, so if you want your custom song to also load wScene 31, acceptable names include "caveconc_05_WAFFLES.cnd", "caveconc_05_52_46356.cnd", or "caveconc_05_super_boss.cnd". 

After adding your new CND file, be sure to add it to its respective trackMap file.

== Bonus: Adding new content to a vanilla BMS file ==
Adding new hex data in the middle of a file will shift all the offsets that come after it, causing your BMS to jump to the wrong locations, and likely cause a crash if vanilla songs are loaded. 
In order to add new content in addition to what's already in the BMS:
* Find and copy the gesture set list and the timing ruleset list, and paste them at the end of the file. (Separate them with lots of zeros so you have lots more space to add content to these lists)
* Change <code>0x6</code> and <code>0x14</code> to point to your new gesture set list and timing ruleset list. These two values tell the game where the lists are.
The game should now use these brand new lists, instead of the original instances that occur earlier in the file. Since they still contain all the locations of the vanilla gesture sets/timetables from above in the same order, the existing CND songs won't be affected and will continue to function, but now you can expand upon these lists with brand new entries now that you've made the space for them. All new gestures, gesture sets and timetables can be added further down the file.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Editing_vanilla_BMS_file.png|The new gesture set list and timing ruleset list we want to use will be at the bottom.
</gallery>

== Bonus: Adding gesture cutoffs in timetables ==
An intentional compositional choice in some songs is to cutoff gestures while they're in the middle of playing. The most common way this is done is to quickly trigger another gesture; if the last gesture has not finished playing, it will stop playing that gesture and begin playing the new one. It's also possible to add "empty" gestures to gesture sets (like <code>C40000015DFF</code>, a gesture which ends immediately and plays nothing), so you can randomly interrupt gestures in your song with silence, or have there be a chance to play nothing. 
However, if you wish to interrupt gestures in your song at specified times without the randomness, there is a special function in timetables for doing this. In the vanilla game, this is used for the trumpet in [https://www.youtube.com/watch?v=qOhmS1YLpF8 Fire]. The trumpet plays two interrupted gestures, then plays a third gesture in full. Below is the timetable for this trumpet: 
<code>0078 8168 81E0 00F0 80F0 81E0 0780 FFFF</code> 
The trumpet will:
* <code>0078</code> play a gesture for 1 beat
* <code>8168</code> cutoff after this 1 beat
* <code>81E0</code> extend the silence for another 4 beats
* <code>00F0</code> play a gesture for 2 beats
* <code>80F0</code> cutoff after these 2 beats
* <code>81E0</code> extend the silence for another 4 beats
* <code>0780</code> play a gesture for 16 beats. 
In order to put a "cutoff" in your timetable:
* Start with how long you want your "playing" gesture to play for, before it gets cutoff. I want the the first gesture to last for one beat (four 1/16th notes), so I'll put <code>0078</code>. Remember that every "30" in decimal is equivalent to a sixteenth note.
* Immediately next in the sequence will be a value that indicates when the cutoff begins. Calculate the difference between "81E0" and the previous value you had just inserted. 81E0 - 0078 = 8168 (in decimal, 33248 - 120 = 33128). I will put <code>8168</code> next in my sequence.
My sequence is now <code>0078 8168 FFFF</code>; this will play a gesture normally for 1 beat, but then immediately cut it off after that 1 beat. 
Putting an additional <code>81E0</code> in the sequence right after will extend the silence for another 4 beats if you so desire. You can keep putting <code>81E0</code> right after several times in a row if you want silence to last extra long until the next gesture plays.

[[Category:Pikmin 2]]

Creating Interactive BMS Files

2024-04-18T09:02:28Z

Waffles: /* Missing/dropped notes */

This guide will function as a walkthrough for creating interactive music for Pikmin 2's main areas. 

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be exporting each track of your MIDI separately as its own BMS file, and importing them one at a time.
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

Most of the editing will be done in hexadecimal. Creating [[Creating cave music|cave music]] is very similar.

== Preparing and exporting MIDIs ==
You will be exporting each track of your song as its own separate MIDI file, and then convert each MIDI into a mini BMS file of its own. 
If your song has 14 instruments, then you'll export 14 MIDIs. Make sure each track is the same length so that looping will work properly. 

For some reason, imported BMS files play exactly 4 times as slow in interactive music. So if you import the tracks as is, they will play 4 times as slow. 
Before you export them, you need to modify them to run 4 times as fast. Do not address this by changing the BPM in your DAW, you need to shorten the actual regions instead. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each entire track.
<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial5.png|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>
(Note: While you *can* technically just multiply the BPM value by 4 in the BMS later on, Louie's variant is dependent on the BPM being something normal, so the swing will not be applied properly if you do that.)

== Base BMS file ==
Starting from scratch, here is a base for you to work off of. In a hex editor, copy and paste this into a completely new, blank BMS file:
<pre>E74000A0 0003AC04 0104AA20 050400B1 C1400005 AC04010A AA200504 00B1C140 0105AC04 0110AA20 050400B1 C1400205 AC040116 AA200504 00B1C140 0305AC04 011CAA20 050400B1 C1400405 AC040122 AA200504 00B1C140 0505AC04 0128AA20 050400B1 C1400605 AC04012E AA200504 00B1C140 0705AC04 0134AA20 050400B1 C1400805 AC04013A AA200504 00B1C140 0905AC04 0140AA20 050400B1 C1400A05 AC040146 AA200504 00B1C140 0B05AC04 014CAA20 050400B1 C1400C05 AC040152 AA200504 00B1C140 0D05AC04 0158AA20 050400B1 C1400E05 AC04015E AA200504 00B1C140 0F05FE00 78FD0066 C8000001 9F884B00 C8000000 E9884B00 C8000000 F98001FF 0002AA00 071E0002 E600075A 00032200 07960003 5E0007D2 00039A00 080E0003 D600084A 00041200 08860004 4E0008C2 00048A00 08F30004 C600093A 00050200 09760005 3E0009B2 00057A00 09EE0005 B6000A2A 0005F200 0A660006 2E000AA2 C600E70E 00DF0700 018AE72E 00CF03C8 0000016E E70E00DF 0700018A E72E00CF 03C80000 0180E71E 00E3E700 00E70F00 DF070001 9BC600E7 1F00E3E7 0E00DF07 0001B9E7 4001C805 000000E7 2E00CF03 C8000001 A7E71E00 E74001C8 050001C5 E3E1C800 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 44617920 76657273 696F6E3A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000042 00004900 00560000 50000000 00000000 00000000 5365713A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000294C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0002D0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00030CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000348C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000384C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0003C0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0003FCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000438C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000474C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0004B0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0004ECC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000528C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000564C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0005A0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0005DCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000618C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 53756E73 65742076 65722E3A 00000020 20202000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000042 00004900 00560000 50000000 00000000 00000000 5365713A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000708C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000744C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000780C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0007BCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008F8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000834C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000870C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008ACC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008E8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000924C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000960C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00099CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0009D8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000A14C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000A50C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00058CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 FF000000 3C2D2028 4E756C6C 20747261 636B2061 74203078 30623034 2C20666F 7220616E 7920656D 70747920 74726163 6B732900 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 76767620 50617374 6520796F 75722073 65717565 6E636573 20686572 65212076 76760000 00000000 00000000 00000000 00000000 00000000 00000000</pre>

This file is setup with all the important information already filled out for you. You should resize the window so that you can see all 16 Day tracks and all 16 Sunset tracks evenly spaced on each line:

<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial1.png|You can use this image as a guide for the "mixer".
</gallery>

This section is sort of like a mixer; you can set the volume and stereo panning of each track. More importantly, you also choose the bank and program here. Most importantly, at the end of each track, you select what sequence the track uses. You just type in the offset of the sequence there.

== Importing sequences ==
=== Converting ===
Convert all your MIDIs into BMS files with [[Pikmin 2 custom music|flaaffy]]. You can use the following commands in the command line (make sure to include the "-loop" argument in the first command, so it knows to loop the sequence):

<pre>mareep.exe mareep -errand jolt -input exampletrack02.midi -output exampletrack02.txt -loop
mareep.exe mareep -errand cotton -input exampletrack02.txt -output exampletrack02.bms</pre>

Flaaffy turns the MIDI into a text file before it is converted into a BMS. The text file is "cotton", flaaffy's assembly language. Viewing the cotton file can be useful for double checking there's in fact only one track in each of your MIDIs. You will open each BMS file you make with flaaffy, and copy paste the hex data of each into the bottom of the Base BMS.

=== Copying and pasting ===
In your exported BMS, look for the instance of <code>A420</code> (if there are multiple, use the last occurrence of it). This A420 is what sets the bank of the sequence, and it will be followed by either a 00, 01, 02, 03, 04, or 05 after it. 

If you want to use bank 0, change it to <code>A42000</code>, if you want to use bank 4, change it to <code>A42004</code>, and so on. 

Copy <code>A420</code> and the entire remainder of the file, and paste everything into your Base BMS, anywhere at the bottom of it.

<gallery mode="packed-hover" widths=160px heights=160px>
File:InteractiveBMStutorial2.png|This is what you should copy. If your track has a lot of notes in it, this can be much longer.
</gallery>

<gallery mode="packed-hover" widths=220px heights=220px>
File:InteractiveBMStutorial3.png|This is how you should paste in the sequences.
</gallery>

You should paste each converted BMS on a new line, separated by an empty line of zeros so its easy to tell where each sequence begins.

=== Looping ===
Notice the <code>C80000XXXX</code> at the very end of the sequence you pasted in (the C80000 will be the same, but the numbers at the end will be different). The "XXXX" tells the sequence where the song loops and should restart at. Change XXXX to be where the sequence starts in the base BMS file. (Ex: do <code>C8000011D4</code> if the sequence starts at 0x11D4).

== Finishing touches ==
=== Fill in the mixer ===
After you have imported all the sequences, have made sure all the <code>A420</code>'s have the right bank, and looped them, go back to the Base BMS mixer and fill in the appropriate information. (Bank, program, volume, panning, sequence location.) The "sequence location" will be the offset where each <code>A420</code> is.

(Note: You do not have to import the same sequence over and over again if there are any identical sequences; you are free to reference the same one sequence and just give them different instruments. This is useful for sunset versions or treasure mix instruments.)

=== Null track ===
If you don't want a track to play anything, have it go to the "null track" located at <code>0B04</code>. (If you look, it's just a single "FF", which is a sequence that ends immediately.) This is what each track is set to by default in the provided Base BMS.

=== Tempo ===
You don't have to touch anything in the header at the top of the Base BMS, except for changing the BPM. The BPM for your song is located at 0xEA and takes up two bytes. (Ex: "<code>0066</code>" for 102 BPM).

=== Padding ===
Add in an extra line of zeros or two at the end of your finished Base BMS, because it sometimes crashes if extra padding is not there.

=== trackMap ===
Make sure the tracks in the Base BMS mixer go in order: Main -> Task -> Treasure -> Enemy near -> Battle -> Spiderwort. Same for the sunset version. 
Open the sequence trackMap in <code>/user/Wakai/</code>, find the song you are replacing (forest.bms, last.bms...), and [[Trackmap parameters|edit the values in the trackMap]] to reflect how many instruments will be in each mix. The main and sunset version will use the same mapping. You can make unnecessary tracks silent in the Base BMS's mixer if your sunset version has less instruments.

== Troubleshooting ==
=== Tracks not looping correctly ===
Make sure each track is exactly the same length. You can export your entire song as one MIDI, convert it to BMS, and import it into the game as an un-interactive BMS file just to check. Flaaffy is finicky with looping occasionally; you may need to add a note at the end or start of a track so flaaffy knows thats the definitive start/end point of that track. (Make the note very quiet, low-pitch, and or short so its practically inaudible.)

=== Tracks not looping at all ===
Double-check you added the -loop argument in flaaffy. Test with an un-interactive BMS file. Make sure there isn't any stray information somewhere in your MIDI.

=== Volume/panning/program settings not working ===
It is possible there is volume automation, panning automation, or program changes somewhere in your MIDI/BMS you have imported. This is something you can add intentionally if you really want to (like changing the program for a track in the middle of the song), but it will override the values you put in the Base BMS mixer.

=== Missing/dropped notes ===
This is an another issue with flaaffy. If a "Note On" also occurs at the same time a "Note Off" does, or multiple "Note On"s occur at the exact same millisecond, flaaffy's BMS won't render those notes. You might run into this often when instruments try to play chords. 

The simple fix for flaaffy is to make sure notes of the same pitch do not touch each other (put a tiny bit of empty space between them), and to slightly skew/slant each note in chords.

<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial4.png|Make sure the notes in a chord don't occur at the same time.
</gallery>

Alternatively, JAIMaker does not run into this issue for its BMS conversions. If you decide to use it instead, you will need to be more precise about importing the data from the BMS files into the Base BMS.

Creating Interactive BMS Files

2024-04-18T09:00:01Z

Waffles:

This guide will function as a walkthrough for creating interactive music for Pikmin 2's main areas. 

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be exporting each track of your MIDI separately as its own BMS file, and importing them one at a time.
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

Most of the editing will be done in hexadecimal. Creating [[Creating cave music|cave music]] is very similar.

== Preparing and exporting MIDIs ==
You will be exporting each track of your song as its own separate MIDI file, and then convert each MIDI into a mini BMS file of its own. 
If your song has 14 instruments, then you'll export 14 MIDIs. Make sure each track is the same length so that looping will work properly. 

For some reason, imported BMS files play exactly 4 times as slow in interactive music. So if you import the tracks as is, they will play 4 times as slow. 
Before you export them, you need to modify them to run 4 times as fast. Do not address this by changing the BPM in your DAW, you need to shorten the actual regions instead. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each entire track.
<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial5.png|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>
(Note: While you *can* technically just multiply the BPM value by 4 in the BMS later on, Louie's variant is dependent on the BPM being something normal, so the swing will not be applied properly if you do that.)

== Base BMS file ==
Starting from scratch, here is a base for you to work off of. In a hex editor, copy and paste this into a completely new, blank BMS file:
<pre>E74000A0 0003AC04 0104AA20 050400B1 C1400005 AC04010A AA200504 00B1C140 0105AC04 0110AA20 050400B1 C1400205 AC040116 AA200504 00B1C140 0305AC04 011CAA20 050400B1 C1400405 AC040122 AA200504 00B1C140 0505AC04 0128AA20 050400B1 C1400605 AC04012E AA200504 00B1C140 0705AC04 0134AA20 050400B1 C1400805 AC04013A AA200504 00B1C140 0905AC04 0140AA20 050400B1 C1400A05 AC040146 AA200504 00B1C140 0B05AC04 014CAA20 050400B1 C1400C05 AC040152 AA200504 00B1C140 0D05AC04 0158AA20 050400B1 C1400E05 AC04015E AA200504 00B1C140 0F05FE00 78FD0066 C8000001 9F884B00 C8000000 E9884B00 C8000000 F98001FF 0002AA00 071E0002 E600075A 00032200 07960003 5E0007D2 00039A00 080E0003 D600084A 00041200 08860004 4E0008C2 00048A00 08F30004 C600093A 00050200 09760005 3E0009B2 00057A00 09EE0005 B6000A2A 0005F200 0A660006 2E000AA2 C600E70E 00DF0700 018AE72E 00CF03C8 0000016E E70E00DF 0700018A E72E00CF 03C80000 0180E71E 00E3E700 00E70F00 DF070001 9BC600E7 1F00E3E7 0E00DF07 0001B9E7 4001C805 000000E7 2E00CF03 C8000001 A7E71E00 E74001C8 050001C5 E3E1C800 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 44617920 76657273 696F6E3A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000042 00004900 00560000 50000000 00000000 00000000 5365713A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000294C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0002D0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00030CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000348C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000384C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0003C0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0003FCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000438C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000474C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0004B0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0004ECC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000528C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000564C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0005A0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0005DCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000618C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 53756E73 65742076 65722E3A 00000020 20202000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000042 00004900 00560000 50000000 00000000 00000000 5365713A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000708C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000744C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000780C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0007BCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008F8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000834C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000870C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008ACC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008E8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000924C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000960C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00099CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0009D8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000A14C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000A50C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00058CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 FF000000 3C2D2028 4E756C6C 20747261 636B2061 74203078 30623034 2C20666F 7220616E 7920656D 70747920 74726163 6B732900 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 76767620 50617374 6520796F 75722073 65717565 6E636573 20686572 65212076 76760000 00000000 00000000 00000000 00000000 00000000 00000000</pre>

This file is setup with all the important information already filled out for you. You should resize the window so that you can see all 16 Day tracks and all 16 Sunset tracks evenly spaced on each line:

<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial1.png|You can use this image as a guide for the "mixer".
</gallery>

This section is sort of like a mixer; you can set the volume and stereo panning of each track. More importantly, you also choose the bank and program here. Most importantly, at the end of each track, you select what sequence the track uses. You just type in the offset of the sequence there.

== Importing sequences ==
=== Converting ===
Convert all your MIDIs into BMS files with [[Pikmin 2 custom music|flaaffy]]. You can use the following commands in the command line (make sure to include the "-loop" argument in the first command, so it knows to loop the sequence):

<pre>mareep.exe mareep -errand jolt -input exampletrack02.midi -output exampletrack02.txt -loop
mareep.exe mareep -errand cotton -input exampletrack02.txt -output exampletrack02.bms</pre>

Flaaffy turns the MIDI into a text file before it is converted into a BMS. The text file is "cotton", flaaffy's assembly language. Viewing the cotton file can be useful for double checking there's in fact only one track in each of your MIDIs. You will open each BMS file you make with flaaffy, and copy paste the hex data of each into the bottom of the Base BMS.

=== Copying and pasting ===
In your exported BMS, look for the instance of <code>A420</code> (if there are multiple, use the last occurrence of it). This A420 is what sets the bank of the sequence, and it will be followed by either a 00, 01, 02, 03, 04, or 05 after it. 

If you want to use bank 0, change it to <code>A42000</code>, if you want to use bank 4, change it to <code>A42004</code>, and so on. 

Copy <code>A420</code> and the entire remainder of the file, and paste everything into your Base BMS, anywhere at the bottom of it.

<gallery mode="packed-hover" widths=160px heights=160px>
File:InteractiveBMStutorial2.png|This is what you should copy. If your track has a lot of notes in it, this can be much longer.
</gallery>

<gallery mode="packed-hover" widths=220px heights=220px>
File:InteractiveBMStutorial3.png|This is how you should paste in the sequences.
</gallery>

You should paste each converted BMS on a new line, separated by an empty line of zeros so its easy to tell where each sequence begins.

=== Looping ===
Notice the <code>C80000XXXX</code> at the very end of the sequence you pasted in (the C80000 will be the same, but the numbers at the end will be different). The "XXXX" tells the sequence where the song loops and should restart at. Change XXXX to be where the sequence starts in the base BMS file. (Ex: do <code>C8000011D4</code> if the sequence starts at 0x11D4).

== Finishing touches ==
=== Fill in the mixer ===
After you have imported all the sequences, have made sure all the <code>A420</code>'s have the right bank, and looped them, go back to the Base BMS mixer and fill in the appropriate information. (Bank, program, volume, panning, sequence location.) The "sequence location" will be the offset where each <code>A420</code> is.

(Note: You do not have to import the same sequence over and over again if there are any identical sequences; you are free to reference the same one sequence and just give them different instruments. This is useful for sunset versions or treasure mix instruments.)

=== Null track ===
If you don't want a track to play anything, have it go to the "null track" located at <code>0B04</code>. (If you look, it's just a single "FF", which is a sequence that ends immediately.) This is what each track is set to by default in the provided Base BMS.

=== Tempo ===
You don't have to touch anything in the header at the top of the Base BMS, except for changing the BPM. The BPM for your song is located at 0xEA and takes up two bytes. (Ex: "<code>0066</code>" for 102 BPM).

=== Padding ===
Add in an extra line of zeros or two at the end of your finished Base BMS, because it sometimes crashes if extra padding is not there.

=== trackMap ===
Make sure the tracks in the Base BMS mixer go in order: Main -> Task -> Treasure -> Enemy near -> Battle -> Spiderwort. Same for the sunset version. 
Open the sequence trackMap in <code>/user/Wakai/</code>, find the song you are replacing (forest.bms, last.bms...), and [[Trackmap parameters|edit the values in the trackMap]] to reflect how many instruments will be in each mix. The main and sunset version will use the same mapping. You can make unnecessary tracks silent in the Base BMS's mixer if your sunset version has less instruments.

== Troubleshooting ==
=== Tracks not looping correctly ===
Make sure each track is exactly the same length. You can export your entire song as one MIDI, convert it to BMS, and import it into the game as an un-interactive BMS file just to check. Flaaffy is finicky with looping occasionally; you may need to add a note at the end or start of a track so flaaffy knows thats the definitive start/end point of that track. (Make the note very quiet, low-pitch, and or short so its practically inaudible.)

=== Tracks not looping at all ===
Double-check you added the -loop argument in flaaffy. Test with an un-interactive BMS file. Make sure there isn't any stray information somewhere in your MIDI.

=== Volume/panning/program settings not working ===
It is possible there is volume automation, panning automation, or program changes somewhere in your MIDI/BMS you have imported. This is something you can add intentionally if you really want to (like changing the program for a track in the middle of the song), but it will override the values you put in the Base BMS mixer.

=== Missing/dropped notes ===
This is an another issue with flaaffy. If a "Note Off" also occurs at the same time a "Note On" does, or multiple "Note On"s occur at the exact same millisecond, flaaffy won't render these correctly. You might run into this often when instruments try to play chords. 

The simple fix for flaaffy is to make sure notes of the same pitch do not touch each other, and to slightly skew or slant the notes of chords.

<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial4.png|Make sure the notes in a chord don't occur at the same time.
</gallery>

Alternatively, JAIMaker does not run into this issue for its BMS conversions. If you decide to use it instead, you will need to be more precise about importing the data from the BMS files into the Base BMS.

File:InteractiveBMStutorial5.png.png

2024-04-18T08:57:18Z

Waffles: Waffles moved page File:InteractiveBMStutorial5.png.png to File:InteractiveBMStutorial5.png: extention mistake

#REDIRECT [[File:InteractiveBMStutorial5.png]]

File:InteractiveBMStutorial5.png

2024-04-18T08:57:18Z

Waffles: Waffles moved page File:InteractiveBMStutorial5.png.png to File:InteractiveBMStutorial5.png: extention mistake

== Summary ==
Tutorial for creating interactive BMS.

File:InteractiveBMStutorial5.png

2024-04-18T08:56:08Z

Waffles: Tutorial for creating interactive BMS.

== Summary ==
Tutorial for creating interactive BMS.

Creating Interactive BMS Files

2024-04-18T08:43:58Z

Waffles: /* Preparing and exporting MIDIs */ Ah oops

This guide will function as a walkthrough for creating interactive music for Pikmin 2's main areas. 

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be exporting each track of your MIDI separately as its own BMS file, and importing them one at a time.
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

Most of the editing will be done in hexadecimal. Creating [[Creating cave music|cave music]] is very similar.

== Preparing and exporting MIDIs ==
You will be exporting each track of your song as its own separate MIDI file, and then convert each MIDI into a mini BMS file of its own. 
If your song has 14 instruments, then you'll export 14 MIDIs. Make sure each track is the same length so that looping will work properly. 

For some reason, imported BMS files play exactly 4 times as slow in interactive music. So if you import the tracks as is, they will play 4 times as slow. 
Before you export them, you need to modify them to run 4 times as fast. Do not address this by changing the BPM in your DAW, you need to shorten the actual regions instead. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each entire track.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>
(Note: While you *can* technically just multiply the BPM value by 4 in the BMS later on, Louie's variant is dependent on the BPM being something normal, so the swing will not be applied properly if you do that.)

== Base BMS file ==
Starting from scratch, here is a base for you to work off of. In a hex editor, copy and paste this into a completely new, blank BMS file:
<pre>E74000A0 0003AC04 0104AA20 050400B1 C1400005 AC04010A AA200504 00B1C140 0105AC04 0110AA20 050400B1 C1400205 AC040116 AA200504 00B1C140 0305AC04 011CAA20 050400B1 C1400405 AC040122 AA200504 00B1C140 0505AC04 0128AA20 050400B1 C1400605 AC04012E AA200504 00B1C140 0705AC04 0134AA20 050400B1 C1400805 AC04013A AA200504 00B1C140 0905AC04 0140AA20 050400B1 C1400A05 AC040146 AA200504 00B1C140 0B05AC04 014CAA20 050400B1 C1400C05 AC040152 AA200504 00B1C140 0D05AC04 0158AA20 050400B1 C1400E05 AC04015E AA200504 00B1C140 0F05FE00 78FD0066 C8000001 9F884B00 C8000000 E9884B00 C8000000 F98001FF 0002AA00 071E0002 E600075A 00032200 07960003 5E0007D2 00039A00 080E0003 D600084A 00041200 08860004 4E0008C2 00048A00 08F30004 C600093A 00050200 09760005 3E0009B2 00057A00 09EE0005 B6000A2A 0005F200 0A660006 2E000AA2 C600E70E 00DF0700 018AE72E 00CF03C8 0000016E E70E00DF 0700018A E72E00CF 03C80000 0180E71E 00E3E700 00E70F00 DF070001 9BC600E7 1F00E3E7 0E00DF07 0001B9E7 4001C805 000000E7 2E00CF03 C8000001 A7E71E00 E74001C8 050001C5 E3E1C800 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 44617920 76657273 696F6E3A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000042 00004900 00560000 50000000 00000000 00000000 5365713A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000294C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0002D0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00030CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000348C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000384C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0003C0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0003FCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000438C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000474C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0004B0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0004ECC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000528C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000564C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0005A0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0005DCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000618C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 53756E73 65742076 65722E3A 00000020 20202000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000042 00004900 00560000 50000000 00000000 00000000 5365713A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000708C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000744C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000780C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0007BCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008F8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000834C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000870C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008ACC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008E8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000924C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000960C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00099CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0009D8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000A14C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000A50C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00058CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 FF000000 3C2D2028 4E756C6C 20747261 636B2061 74203078 30623034 2C20666F 7220616E 7920656D 70747920 74726163 6B732900 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 76767620 50617374 6520796F 75722073 65717565 6E636573 20686572 65212076 76760000 00000000 00000000 00000000 00000000 00000000 00000000</pre>

This file is setup with all the important information already filled out for you. You should resize the window so that you can see all 16 Day tracks and all 16 Sunset tracks evenly spaced on each line:

<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial1.png|You can use this image as a guide for the "mixer".
</gallery>

This section is sort of like a mixer; you can set the volume and stereo panning of each track. More importantly, you also choose the bank and program here. Most importantly, at the end of each track, you select what sequence the track uses. You just type in the offset of the sequence there.

== Importing sequences ==
=== Converting ===
Convert all your MIDIs into BMS files with [[Pikmin 2 custom music|flaaffy]]. You can use the following commands in the command line (make sure to include the "-loop" argument in the first command, so it knows to loop the sequence):

<pre>mareep.exe mareep -errand jolt -input exampletrack02.midi -output exampletrack02.txt -loop
mareep.exe mareep -errand cotton -input exampletrack02.txt -output exampletrack02.bms</pre>

Flaaffy turns the MIDI into a text file before it is converted into a BMS. The text file is "cotton", flaaffy's assembly language. Viewing the cotton file can be useful for double checking there's in fact only one track in each of your MIDIs. You will open each BMS file you make with flaaffy, and copy paste the hex data of each into the bottom of the Base BMS.

=== Copying and pasting ===
In your exported BMS, look for the instance of <code>A420</code> (if there are multiple, use the last occurrence of it). This A420 is what sets the bank of the sequence, and it will be followed by either a 00, 01, 02, 03, 04, or 05 after it. 

If you want to use bank 0, change it to <code>A42000</code>, if you want to use bank 4, change it to <code>A42004</code>, and so on. 

Copy <code>A420</code> and the entire remainder of the file, and paste everything into your Base BMS, anywhere at the bottom of it.

<gallery mode="packed-hover" widths=160px heights=160px>
File:InteractiveBMStutorial2.png|This is what you should copy. If your track has a lot of notes in it, this can be much longer.
</gallery>

<gallery mode="packed-hover" widths=220px heights=220px>
File:InteractiveBMStutorial3.png|This is how you should paste in the sequences.
</gallery>

You should paste each converted BMS on a new line, separated by an empty line of zeros so its easy to tell where each sequence begins.

=== Looping ===
Notice the <code>C80000XXXX</code> at the very end of the sequence you pasted in (the C80000 will be the same, but the numbers at the end will be different). The "XXXX" tells the sequence where the song loops and should restart at. Change XXXX to be where the sequence starts in the base BMS file. (Ex: do <code>C8000011D4</code> if the sequence starts at 0x11D4).

== Finishing touches ==
=== Fill in the mixer ===
After you have imported all the sequences, have made sure all the <code>A420</code>'s have the right bank, and looped them, go back to the mixer and fill in the appropriate information. (Bank, program, volume, panning, sequence location.) The "sequence location" will be the offset where each <code>A420</code> is.

(Note: You do not have to import the same sequence over and over again if there are any identical sequences; you are free to reference the same one sequence and just give them different instruments. This is useful for sunset versions or treasure mix instruments.)

=== Null track ===
If you don't want a track to play anything, have it go to the "null track" located at <code>0B04</code>. (If you look, it's just a single "FF", which is a sequence that ends immediately.) This is what each track is set to by default in the provided Base BMS.

=== Tempo ===
You don't have to touch anything in the header at the top of the Base BMS, except for changing the BPM. The BPM for your song is located at 0xEA and takes up two bytes. (Ex: "<code>0066</code>" for 102 BPM).

=== Padding ===
Add in an extra line of zeros or two at the end of your finished Base BMS, because it sometimes crashes if extra padding is not there.

=== trackMap ===
Make sure the tracks in the mixer go in order: Main -> Task -> Treasure -> Enemy near -> Battle -> Spiderwort. Same for the sunset version. 
Open the sequence trackMap in <code>/user/Wakai/</code>, find the song you are replacing (forest.bms, last.bms...), and [[Trackmap parameters|edit the values in the trackMap]] to reflect how many instruments will be in each mix. The main and sunset version will use the same mapping. You can make unnecessary tracks silent in the Base BMS's mixer if your sunset version has less instruments.

== Troubleshooting ==
=== Tracks not looping correctly ===
Make sure each track is exactly the same length. You can export your entire song as one MIDI, convert it to BMS, and import it into the game as an un-interactive BMS file just to check. Flaaffy is finicky with looping occasionally; you may need to add a note at the end or start of a track so flaaffy knows thats the definitive start/end point of that track. (Make the note very quiet, low-pitch, and or short so its practically inaudible.)

=== Tracks not looping at all ===
Double-check you added the -loop argument in flaaffy. Test with an un-interactive BMS file. Make sure there isn't any stray information somewhere in your MIDI.

=== Volume/panning/program settings not working ===
It is possible there is volume automation, panning automation, or program changes somewhere in your MIDI/BMS you have imported. This is something you can add intentionally if you really want to (like changing the program for a track in the middle of the song), but it will override the values you put in the mixer.

=== Missing/dropped notes ===
This is an another issue with flaaffy. If a "Note Off" also occurs at the same time a "Note On" does, or multiple "Note On"s occur at the exact same millisecond, flaaffy won't render these correctly. You might run into this often when instruments try to play chords. 

The simple fix for flaaffy is to make sure notes of the same pitch do not touch each other, and to slightly skew or slant the notes of chords.

<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial4.png|Make sure the notes in a chord don't occur at the same time.
</gallery>

Alternatively, JAIMaker does not run into this issue for its BMS conversions. If you decide to use it instead, you will need to be more precise about importing the data from the BMS files into the Base BMS.

Creating Interactive BMS Files

2024-04-18T08:43:19Z

Waffles: /* Preparing and exporting MIDIs */

This guide will function as a walkthrough for creating interactive music for Pikmin 2's main areas. 

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be exporting each track of your MIDI separately as its own BMS file, and importing them one at a time.
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

Most of the editing will be done in hexadecimal. Creating [[Creating cave music|cave music]] is very similar.

== Preparing and exporting MIDIs ==
You will be exporting each track of your song as its own separate MIDI file, and then convert each MIDI into a mini BMS file of its own. 
If your song has 14 instruments, then you'll export 14 MIDIs. Make sure each track is the same length so that looping will work properly. 

For some reason, imported BMS files play exactly 4 times as slow in interactive music. So if you import the tracks as is, they will play 4 times as slow. 
Before you export them, you need to modify them to run 4 times as fast. Do not address this by changing the BPM in your DAW, you need to shorten the actual regions instead. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each block.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>
(Note: While you *can* technically just multiply the BPM value by 4 in the BMS later on, Louie's variant is dependent on the BPM being something normal, so the swing will not be applied properly if you do that.)

== Base BMS file ==
Starting from scratch, here is a base for you to work off of. In a hex editor, copy and paste this into a completely new, blank BMS file:
<pre>E74000A0 0003AC04 0104AA20 050400B1 C1400005 AC04010A AA200504 00B1C140 0105AC04 0110AA20 050400B1 C1400205 AC040116 AA200504 00B1C140 0305AC04 011CAA20 050400B1 C1400405 AC040122 AA200504 00B1C140 0505AC04 0128AA20 050400B1 C1400605 AC04012E AA200504 00B1C140 0705AC04 0134AA20 050400B1 C1400805 AC04013A AA200504 00B1C140 0905AC04 0140AA20 050400B1 C1400A05 AC040146 AA200504 00B1C140 0B05AC04 014CAA20 050400B1 C1400C05 AC040152 AA200504 00B1C140 0D05AC04 0158AA20 050400B1 C1400E05 AC04015E AA200504 00B1C140 0F05FE00 78FD0066 C8000001 9F884B00 C8000000 E9884B00 C8000000 F98001FF 0002AA00 071E0002 E600075A 00032200 07960003 5E0007D2 00039A00 080E0003 D600084A 00041200 08860004 4E0008C2 00048A00 08F30004 C600093A 00050200 09760005 3E0009B2 00057A00 09EE0005 B6000A2A 0005F200 0A660006 2E000AA2 C600E70E 00DF0700 018AE72E 00CF03C8 0000016E E70E00DF 0700018A E72E00CF 03C80000 0180E71E 00E3E700 00E70F00 DF070001 9BC600E7 1F00E3E7 0E00DF07 0001B9E7 4001C805 000000E7 2E00CF03 C8000001 A7E71E00 E74001C8 050001C5 E3E1C800 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 44617920 76657273 696F6E3A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000042 00004900 00560000 50000000 00000000 00000000 5365713A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000294C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0002D0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00030CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000348C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000384C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0003C0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0003FCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000438C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000474C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0004B0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0004ECC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000528C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000564C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0005A0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0005DCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000618C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 53756E73 65742076 65722E3A 00000020 20202000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000042 00004900 00560000 50000000 00000000 00000000 5365713A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000708C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000744C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000780C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0007BCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008F8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000834C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000870C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008ACC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008E8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000924C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000960C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00099CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0009D8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000A14C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000A50C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00058CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 FF000000 3C2D2028 4E756C6C 20747261 636B2061 74203078 30623034 2C20666F 7220616E 7920656D 70747920 74726163 6B732900 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 76767620 50617374 6520796F 75722073 65717565 6E636573 20686572 65212076 76760000 00000000 00000000 00000000 00000000 00000000 00000000</pre>

This file is setup with all the important information already filled out for you. You should resize the window so that you can see all 16 Day tracks and all 16 Sunset tracks evenly spaced on each line:

<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial1.png|You can use this image as a guide for the "mixer".
</gallery>

This section is sort of like a mixer; you can set the volume and stereo panning of each track. More importantly, you also choose the bank and program here. Most importantly, at the end of each track, you select what sequence the track uses. You just type in the offset of the sequence there.

== Importing sequences ==
=== Converting ===
Convert all your MIDIs into BMS files with [[Pikmin 2 custom music|flaaffy]]. You can use the following commands in the command line (make sure to include the "-loop" argument in the first command, so it knows to loop the sequence):

<pre>mareep.exe mareep -errand jolt -input exampletrack02.midi -output exampletrack02.txt -loop
mareep.exe mareep -errand cotton -input exampletrack02.txt -output exampletrack02.bms</pre>

Flaaffy turns the MIDI into a text file before it is converted into a BMS. The text file is "cotton", flaaffy's assembly language. Viewing the cotton file can be useful for double checking there's in fact only one track in each of your MIDIs. You will open each BMS file you make with flaaffy, and copy paste the hex data of each into the bottom of the Base BMS.

=== Copying and pasting ===
In your exported BMS, look for the instance of <code>A420</code> (if there are multiple, use the last occurrence of it). This A420 is what sets the bank of the sequence, and it will be followed by either a 00, 01, 02, 03, 04, or 05 after it. 

If you want to use bank 0, change it to <code>A42000</code>, if you want to use bank 4, change it to <code>A42004</code>, and so on. 

Copy <code>A420</code> and the entire remainder of the file, and paste everything into your Base BMS, anywhere at the bottom of it.

<gallery mode="packed-hover" widths=160px heights=160px>
File:InteractiveBMStutorial2.png|This is what you should copy. If your track has a lot of notes in it, this can be much longer.
</gallery>

<gallery mode="packed-hover" widths=220px heights=220px>
File:InteractiveBMStutorial3.png|This is how you should paste in the sequences.
</gallery>

You should paste each converted BMS on a new line, separated by an empty line of zeros so its easy to tell where each sequence begins.

=== Looping ===
Notice the <code>C80000XXXX</code> at the very end of the sequence you pasted in (the C80000 will be the same, but the numbers at the end will be different). The "XXXX" tells the sequence where the song loops and should restart at. Change XXXX to be where the sequence starts in the base BMS file. (Ex: do <code>C8000011D4</code> if the sequence starts at 0x11D4).

== Finishing touches ==
=== Fill in the mixer ===
After you have imported all the sequences, have made sure all the <code>A420</code>'s have the right bank, and looped them, go back to the mixer and fill in the appropriate information. (Bank, program, volume, panning, sequence location.) The "sequence location" will be the offset where each <code>A420</code> is.

(Note: You do not have to import the same sequence over and over again if there are any identical sequences; you are free to reference the same one sequence and just give them different instruments. This is useful for sunset versions or treasure mix instruments.)

=== Null track ===
If you don't want a track to play anything, have it go to the "null track" located at <code>0B04</code>. (If you look, it's just a single "FF", which is a sequence that ends immediately.) This is what each track is set to by default in the provided Base BMS.

=== Tempo ===
You don't have to touch anything in the header at the top of the Base BMS, except for changing the BPM. The BPM for your song is located at 0xEA and takes up two bytes. (Ex: "<code>0066</code>" for 102 BPM).

=== Padding ===
Add in an extra line of zeros or two at the end of your finished Base BMS, because it sometimes crashes if extra padding is not there.

=== trackMap ===
Make sure the tracks in the mixer go in order: Main -> Task -> Treasure -> Enemy near -> Battle -> Spiderwort. Same for the sunset version. 
Open the sequence trackMap in <code>/user/Wakai/</code>, find the song you are replacing (forest.bms, last.bms...), and [[Trackmap parameters|edit the values in the trackMap]] to reflect how many instruments will be in each mix. The main and sunset version will use the same mapping. You can make unnecessary tracks silent in the Base BMS's mixer if your sunset version has less instruments.

== Troubleshooting ==
=== Tracks not looping correctly ===
Make sure each track is exactly the same length. You can export your entire song as one MIDI, convert it to BMS, and import it into the game as an un-interactive BMS file just to check. Flaaffy is finicky with looping occasionally; you may need to add a note at the end or start of a track so flaaffy knows thats the definitive start/end point of that track. (Make the note very quiet, low-pitch, and or short so its practically inaudible.)

=== Tracks not looping at all ===
Double-check you added the -loop argument in flaaffy. Test with an un-interactive BMS file. Make sure there isn't any stray information somewhere in your MIDI.

=== Volume/panning/program settings not working ===
It is possible there is volume automation, panning automation, or program changes somewhere in your MIDI/BMS you have imported. This is something you can add intentionally if you really want to (like changing the program for a track in the middle of the song), but it will override the values you put in the mixer.

=== Missing/dropped notes ===
This is an another issue with flaaffy. If a "Note Off" also occurs at the same time a "Note On" does, or multiple "Note On"s occur at the exact same millisecond, flaaffy won't render these correctly. You might run into this often when instruments try to play chords. 

The simple fix for flaaffy is to make sure notes of the same pitch do not touch each other, and to slightly skew or slant the notes of chords.

<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial4.png|Make sure the notes in a chord don't occur at the same time.
</gallery>

Alternatively, JAIMaker does not run into this issue for its BMS conversions. If you decide to use it instead, you will need to be more precise about importing the data from the BMS files into the Base BMS.

Creating Interactive BMS Files

2024-04-18T08:42:12Z

Waffles: /* Preparing and exporting MIDIs */

This guide will function as a walkthrough for creating interactive music for Pikmin 2's main areas. 

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be exporting each track of your MIDI separately as its own BMS file, and importing them one at a time.
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

Most of the editing will be done in hexadecimal. Creating [[Creating cave music|cave music]] is very similar.

== Preparing and exporting MIDIs ==
You will be exporting each track of your song as its own separate MIDI file, and then convert each MIDI into a mini BMS file of its own. 
If your song has 14 instruments, then you'll export 14 MIDIs. Make sure each track is the same length so that looping will work properly. 

For some reason, imported BMS files play exactly 4 times as slow in interactive music. So if you import the tracks as is, they will play 4 times as slow. 
Before you export them, you need to modify them to run 4 times as fast. Do not address this by changing the BPM in your DAW, you need to shorten the actual regions instead. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>
(Note: While you *can* technically just multiply the BPM value by 4 in the BMS later on, Louie's variant is dependent on the BPM being something normal, so the swing will not be applied properly if you do that.)

== Base BMS file ==
Starting from scratch, here is a base for you to work off of. In a hex editor, copy and paste this into a completely new, blank BMS file:
<pre>E74000A0 0003AC04 0104AA20 050400B1 C1400005 AC04010A AA200504 00B1C140 0105AC04 0110AA20 050400B1 C1400205 AC040116 AA200504 00B1C140 0305AC04 011CAA20 050400B1 C1400405 AC040122 AA200504 00B1C140 0505AC04 0128AA20 050400B1 C1400605 AC04012E AA200504 00B1C140 0705AC04 0134AA20 050400B1 C1400805 AC04013A AA200504 00B1C140 0905AC04 0140AA20 050400B1 C1400A05 AC040146 AA200504 00B1C140 0B05AC04 014CAA20 050400B1 C1400C05 AC040152 AA200504 00B1C140 0D05AC04 0158AA20 050400B1 C1400E05 AC04015E AA200504 00B1C140 0F05FE00 78FD0066 C8000001 9F884B00 C8000000 E9884B00 C8000000 F98001FF 0002AA00 071E0002 E600075A 00032200 07960003 5E0007D2 00039A00 080E0003 D600084A 00041200 08860004 4E0008C2 00048A00 08F30004 C600093A 00050200 09760005 3E0009B2 00057A00 09EE0005 B6000A2A 0005F200 0A660006 2E000AA2 C600E70E 00DF0700 018AE72E 00CF03C8 0000016E E70E00DF 0700018A E72E00CF 03C80000 0180E71E 00E3E700 00E70F00 DF070001 9BC600E7 1F00E3E7 0E00DF07 0001B9E7 4001C805 000000E7 2E00CF03 C8000001 A7E71E00 E74001C8 050001C5 E3E1C800 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 44617920 76657273 696F6E3A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000042 00004900 00560000 50000000 00000000 00000000 5365713A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000294C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0002D0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00030CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000348C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000384C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0003C0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0003FCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000438C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000474C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0004B0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0004ECC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000528C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000564C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0005A0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0005DCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000618C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 53756E73 65742076 65722E3A 00000020 20202000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000042 00004900 00560000 50000000 00000000 00000000 5365713A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000708C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000744C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000780C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0007BCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008F8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000834C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000870C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008ACC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008E8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000924C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000960C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00099CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0009D8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000A14C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000A50C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00058CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 FF000000 3C2D2028 4E756C6C 20747261 636B2061 74203078 30623034 2C20666F 7220616E 7920656D 70747920 74726163 6B732900 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 76767620 50617374 6520796F 75722073 65717565 6E636573 20686572 65212076 76760000 00000000 00000000 00000000 00000000 00000000 00000000</pre>

This file is setup with all the important information already filled out for you. You should resize the window so that you can see all 16 Day tracks and all 16 Sunset tracks evenly spaced on each line:

<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial1.png|You can use this image as a guide for the "mixer".
</gallery>

This section is sort of like a mixer; you can set the volume and stereo panning of each track. More importantly, you also choose the bank and program here. Most importantly, at the end of each track, you select what sequence the track uses. You just type in the offset of the sequence there.

== Importing sequences ==
=== Converting ===
Convert all your MIDIs into BMS files with [[Pikmin 2 custom music|flaaffy]]. You can use the following commands in the command line (make sure to include the "-loop" argument in the first command, so it knows to loop the sequence):

<pre>mareep.exe mareep -errand jolt -input exampletrack02.midi -output exampletrack02.txt -loop
mareep.exe mareep -errand cotton -input exampletrack02.txt -output exampletrack02.bms</pre>

Flaaffy turns the MIDI into a text file before it is converted into a BMS. The text file is "cotton", flaaffy's assembly language. Viewing the cotton file can be useful for double checking there's in fact only one track in each of your MIDIs. You will open each BMS file you make with flaaffy, and copy paste the hex data of each into the bottom of the Base BMS.

=== Copying and pasting ===
In your exported BMS, look for the instance of <code>A420</code> (if there are multiple, use the last occurrence of it). This A420 is what sets the bank of the sequence, and it will be followed by either a 00, 01, 02, 03, 04, or 05 after it. 

If you want to use bank 0, change it to <code>A42000</code>, if you want to use bank 4, change it to <code>A42004</code>, and so on. 

Copy <code>A420</code> and the entire remainder of the file, and paste everything into your Base BMS, anywhere at the bottom of it.

<gallery mode="packed-hover" widths=160px heights=160px>
File:InteractiveBMStutorial2.png|This is what you should copy. If your track has a lot of notes in it, this can be much longer.
</gallery>

<gallery mode="packed-hover" widths=220px heights=220px>
File:InteractiveBMStutorial3.png|This is how you should paste in the sequences.
</gallery>

You should paste each converted BMS on a new line, separated by an empty line of zeros so its easy to tell where each sequence begins.

=== Looping ===
Notice the <code>C80000XXXX</code> at the very end of the sequence you pasted in (the C80000 will be the same, but the numbers at the end will be different). The "XXXX" tells the sequence where the song loops and should restart at. Change XXXX to be where the sequence starts in the base BMS file. (Ex: do <code>C8000011D4</code> if the sequence starts at 0x11D4).

== Finishing touches ==
=== Fill in the mixer ===
After you have imported all the sequences, have made sure all the <code>A420</code>'s have the right bank, and looped them, go back to the mixer and fill in the appropriate information. (Bank, program, volume, panning, sequence location.) The "sequence location" will be the offset where each <code>A420</code> is.

(Note: You do not have to import the same sequence over and over again if there are any identical sequences; you are free to reference the same one sequence and just give them different instruments. This is useful for sunset versions or treasure mix instruments.)

=== Null track ===
If you don't want a track to play anything, have it go to the "null track" located at <code>0B04</code>. (If you look, it's just a single "FF", which is a sequence that ends immediately.) This is what each track is set to by default in the provided Base BMS.

=== Tempo ===
You don't have to touch anything in the header at the top of the Base BMS, except for changing the BPM. The BPM for your song is located at 0xEA and takes up two bytes. (Ex: "<code>0066</code>" for 102 BPM).

=== Padding ===
Add in an extra line of zeros or two at the end of your finished Base BMS, because it sometimes crashes if extra padding is not there.

=== trackMap ===
Make sure the tracks in the mixer go in order: Main -> Task -> Treasure -> Enemy near -> Battle -> Spiderwort. Same for the sunset version. 
Open the sequence trackMap in <code>/user/Wakai/</code>, find the song you are replacing (forest.bms, last.bms...), and [[Trackmap parameters|edit the values in the trackMap]] to reflect how many instruments will be in each mix. The main and sunset version will use the same mapping. You can make unnecessary tracks silent in the Base BMS's mixer if your sunset version has less instruments.

== Troubleshooting ==
=== Tracks not looping correctly ===
Make sure each track is exactly the same length. You can export your entire song as one MIDI, convert it to BMS, and import it into the game as an un-interactive BMS file just to check. Flaaffy is finicky with looping occasionally; you may need to add a note at the end or start of a track so flaaffy knows thats the definitive start/end point of that track. (Make the note very quiet, low-pitch, and or short so its practically inaudible.)

=== Tracks not looping at all ===
Double-check you added the -loop argument in flaaffy. Test with an un-interactive BMS file. Make sure there isn't any stray information somewhere in your MIDI.

=== Volume/panning/program settings not working ===
It is possible there is volume automation, panning automation, or program changes somewhere in your MIDI/BMS you have imported. This is something you can add intentionally if you really want to (like changing the program for a track in the middle of the song), but it will override the values you put in the mixer.

=== Missing/dropped notes ===
This is an another issue with flaaffy. If a "Note Off" also occurs at the same time a "Note On" does, or multiple "Note On"s occur at the exact same millisecond, flaaffy won't render these correctly. You might run into this often when instruments try to play chords. 

The simple fix for flaaffy is to make sure notes of the same pitch do not touch each other, and to slightly skew or slant the notes of chords.

<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial4.png|Make sure the notes in a chord don't occur at the same time.
</gallery>

Alternatively, JAIMaker does not run into this issue for its BMS conversions. If you decide to use it instead, you will need to be more precise about importing the data from the BMS files into the Base BMS.

Main Page

2024-04-18T08:39:24Z

Waffles: BMS file links

{{MainTemplate
| welcome = Welcome to the '''''Pikmin'' Technical Knowledge Base'''!
| blurb = A wiki dedicated to the internal files in ''Pikmin'' games.
| about_title = About
| about_content =
Throughout the years, ''Pikmin'' fans have tinkered with the files inside the games in order to better learn how they work, and to create custom content. Since there are a lot of nuances in every little thing, and since newcomers to the concept of file editing show up all the time, this wiki was created with the purpose of serving as a knowledge base for all that the fans know!

'''Partners''':
* [https://pikminwiki.com Pikipedia] - the ''Pikmin'' wiki
* [https://discord.gg/msMKc3G Pikcord] - the ''Pikmin'' community Discord server
* [https://discord.gg/G7Pgkdh Hocotate Hacker] - the ''Pikmin'' hacking community Discord server
| other_title = What this wiki is ''not''
| other_content =
* It's not a wiki about pirating ''Pikmin'' games.
* It's not a file-sharing service.
* It's not a wiki where you document...
** Canon content. Try [https://pikminwiki.com/ Pikipedia] instead.
** Fan-made content. Try [https://pikminfanon.com/ Pikmin Fanon] instead.
** Unused content or regional differences. Try [https://tcrf.net TCRF] instead.
* It's not an official source of info. The information here is mostly obtained via experimenting, and is subject to change as new discoveries are made.
}}

== Global information ==
{| class="wikitable" style="margin: auto; width: 75%;"
! colspan="3" | Global info
|-
| colspan="3" |
{| style="margin: auto;"
|
* [[General instructions]]
* [[Glossary]]
* [[Save files]]
* [[:Category:Tools|Tools]]
|}
|}

== Game-specific information ==
{| class="wikitable" style="margin: auto; width: 75%;"
! width="20%;" | ''Pikmin'' (and ''New Play Control! Pikmin'')
! width="20%;" | ''Pikmin 2'' (and ''New Play Control! Pikmin 2'')
! width="20%;" | ''Pikmin 3'' (and ''Pikmin 3 Deluxe'')
! width="20%;" | ''Hey! Pikmin''
! width="20%;" | ''Pikmin 4''
|-

! colspan="5" | General
|-
| valign="top" |
* [[Pikmin|Main information]]
* [[Pikmin instructions|Instructions]]
* [[Pikmin cheat codes|Useful cheat codes]]
* [[Pikmin memory addresses|Memory addresses]]
* [[Pikmin glossary|Glossary]]

| valign="top" |
* [[Pikmin 2|Main information]]
* [[Pikmin 2 instructions|Instructions]]
* [[Pikmin 2 cheat codes|Useful cheat codes]]
* [[Pikmin 2 memory addresses|Memory addresses]]
* [[Pikmin 2 troubleshooting|Troubleshooting]]
* [[Pikmin 2 glossary|Glossary]]

| valign="top" |
* [[Pikmin 3|Main information]]
* [[Pikmin 3 instructions|Instructions]]
* [[Pikmin 3 troubleshooting|Troubleshooting]]
* [[Pikmin 3 glossary|Glossary]]

| valign="top" |
* [[Hey! Pikmin|Main information]]
* [[Hey! Pikmin instructions|Instructions]]
* [[Hey! Pikmin troubleshooting|Troubleshooting]]
* [[Hey! Pikmin glossary|Glossary]]

| valign="top" |
* [[Pikmin 4|Main information]]
* [[Pikmin 4 instructions|Instructions]]
* [[Pikmin 4 troubleshooting|Troubleshooting]]
* [[Pikmin 4 glossary|Glossary]]
|-

! colspan="5" | File lists
|-
| valign="top" |
* [[Pikmin directory tree|Directory tree]]
* [[JAM file list|JAM file list (Pikiseq.arc)]]
* [[STX file list|STX file list]]
* [[CIN file list|CIN file list]]

| valign="top" |
* [[Pikmin 2 directory tree|Directory tree]]
* [[AST file list|AST (streamed music)]]
* [[Pikmin 2 BMS file list|BMS (sequenced music)]]
* [[Pikmin 2 CND file list|CND (sequenced music for caves)]]
* [[Guide_To_Sound_File_Names|List of sound effect files in the first bank]]
* [[Pikmin 2 cave units information|List of information of each cave unit]]

| valign="top" |
* [[Pikmin 3 directory tree|''Pikmin 3'' directory tree]]
* [[Pikmin 3 Deluxe directory tree|''Pikmin 3 Deluxe'' directory tree]]
* [[BFSTM file list|BFSTM (streamed music)]]
* [[MSBT file list|MSBT (text string)]]

| valign="top" |
* [[Hey! Pikmin directory tree|Directory tree]]
* [[BCSTM file list|BCSTM (music)]]

| valign="top" |
* [[Pikmin 4 directory tree|directory tree]]
|-

! colspan="5" | Constants
|-
| valign="top" |
* [[Pikmin identifiers|Identifiers]]
* [[Olimar's voyage log table]]

| valign="top" |
* [[Pikmin 2 identifiers|Identifiers]]
* [[Pikmin 2 Pikmin states|Pikmin states]]

| valign="top" |
* [[Pikmin 3 identifiers|Identifiers]]
* [[Pikmin 3 progress value|Progress value]]

| valign="top" |
* [[Hey! Pikmin identifiers|Identifiers]]

| valign="top" |
* [[Pikmin 4 identifiers|Identifiers]]
* [[Pikmin 4 text identifiers|Text Identifiers]]
|-

! colspan="5" | Particle effects
|-
| valign="top" |
* [[PCR particles]]

| valign="top" |
* [[JPC particles]]

| valign="top" |
* [[PTCL particles (Pikmin 3)]]

| valign="top" |
* [[PTCL particles (Hey Pikmin)]]

| valign="top" |

|-

! colspan="5" | Stage generation
|-
| valign="top" |
* [[Pikmin binary GEN format|Binary GEN format]]
* [[Pikmin route|Routes]]

* Outdated pages
** [[Pikmin area generator file|Generator]]
** [[Pikmin gen codes|Gen codes]]

| valign="top" |
* Overworld
** [[Pikmin 2 area generator file|Overworld generation parameters]]
** [[Pikmin 2 map lighting files|Lighting]]
** [[Pikmin 2 waterboxes|Waterbox]]
** [[Pikmin 2 collision format|Collision]]
* Caves
** [[Cave generation parameters|Cave generation parameters]]
** [[Pikmin 2 Challenge Mode settings|Challenge Mode]]
** [[Pikmin 2 cave lighting files|Lighting]]
* Units (cave rooms)
** [[Cave unit generation|Cave unit generation]]
** [[Cave unit definition file|Cave unit definition]]
** [[Cave fixed layout|Cave fixed layout]]
* [[Pikmin 2 route|Routes]]

| valign="top" |

| valign="top" |

| valign="top" |
* Teki Units
** [[NoraSpawner]]
* [[Save Files]]

|-

! colspan="5" | File formats
|-
| valign="top" |
* Archive Formats
** [[Paired ARC+DIR file]]
** [[BUN file]] (also ANM)
* Binary formats
** [[MOD file]] (3D Model)
** [[TXE file]] (Texture)
** [[BTI file]] (Texture)
** [[BLO file]] (2D screen data)
** [[PCR file]] (Particle effect parameters)
** [[DC? files]] (Identifier for either DCA or DCK)
*** [[DCA file]] (Animation)
*** [[DCK file]] (Animation)
** [[H4M file]] (Pre-rendered video)
** [[JAM file]] (Sequenced music)
** [[STX file]] (Streamed music)
** [[AW file]] (Sound Bank)
** [[Pikmin parameter files|Parameter Files]]
* Plaintext Formats
** [[CIN file]] (Cutscene resource manager)
** [[DSK file]] (Cutscene data)
** [[DMD file]] (Intermediary 3D model)
** [[CNV file]] (Intermediary conversion file)
* Unknown Formats
** [[GST file]]
** [[ACT file]]
** [[CARD file]]
* Missing Formats
** [[DVW file]] (Material file?)
** [[JMP file]] (Intermediary plaintext 3D model file?)
** [[MD3 file]] (3D Model)
** [[BSP flle]] (3D Model)

| valign="top" |
* Archive Formats
** [[SZS file]]
** [[RARC file]]
* [[BMD file]] (J3D model)
* [[BTI file]] (Texture)
* [[BTK file]] (Animated texture)
* [[JPC file]] (Particle effect container)
** [[JPA file]] (Particle effect)
* [[BCA file]] (Animation)
* [[BCK file]] (Animation)
* [[BMS file]] (Sequenced music)
* [[AST file]] (Streamed music)
* [[AW file]] (Soundfont)
* [[THP file]] (Pre-rendered video)
* [[BLO file]] (2D screen data)
* [[STB file]] (Cutscene data)
* [[BMG file]] (Text)
* [[BPK file]]
* [[BRK file]]
* [[BMC file]]

* Misc.
** [[DWN file]] (e-Reader minigames?)
** [[DMD file]] (Intermediary 3D model)
** [[Pikmin 2 title screen|Title screen]]
** [[Pikmin 2 save file|Saved game data]]
** [[2-Player Battle stage parameters]]
** [[Mail]]

| valign="top" |

* [[Pikmin 3 radar files|Radar]]
* [[BFSTM file|BFSTM (streamed music)]]
* [[MSBT file (Pikmin 3)|MSBT (text string)]]
* [[FSKB file]] (Unknown)

| valign="top" |

* [[Hey! Pikmin save file|Saved game data]]
* [[ARC file (Hey! Pikmin)|ARC (archive)]]
* [[BCH file|BCH (animation)]]
* [[BFLIM file|BFLIM (image)]]
* [[MSBT file (Hey! Pikmin)|MSBT (text string)]]
* [[Z file|Z (archive)]]

| valign="top" |
* [[WEBM file|WEBM (video)]]
* [[BNVIB file|BNVIB]]
* [[UTOC/UCAS file|UTOC/UCAS (Archive for UASSET Files)]]
* [[UASSET file|UASSET File (Unreal Engine Asset File)]]
* [[UFONT file|UFONT]]
* [[LOCRES file|LOCRES]]
* [[WEM file|WEM]]
* [[BNK file|BNK]]

|-

! colspan="5" | Parameters
|-
| valign="top" |
* [[Pikmin labeled parameter file|Labeled]]
** [[Pikmin AI constants|AI constants]]
** [[Pikmin cunit parameters|Cuint]]
** [[Pikmin demo parameters|Demo]]
** [[Pikmin game parameters|Game parameters]]
** [[Pikmin navi parameters|NaviMgr]]
** [[Pikmin piki parameters|PikiMgr]]
** [[Pikmin sound parameters|Sound]]
** [[Pikmin wave parameters|Wave]]
** [[Pikmin prefs parameters|Prefs]]
** [[Pikmin boss parameters|Boss]]
* [[Pikmin unlabeled parameter file|Unlabeled]]
** [[Pikmin camera parameters|Camera]]
** [[Pikmin key parameters|Key]]
** [[Pikmin enemy parameter file format|Enemy]]

| valign="top" |
* [[naviParms|Leader]]
* [[pikiParms|Pikmin]]
* [[CameraParms|Camera]]
* [[Pikmin 2 enemy parameters|Entity]]
* [[Titan Dweevil parameters]]
* [[Trackmap parameters|trackMap parameters]]

| valign="top" |
* [[carryParam|Carry]]
* [[fruitsParam|Fruit]]
* [[pikminParam|Pikmin]]
* [[itemprogressParam|Item progress]]
* [[Mission settings]]
* [[GameobjectParam|Object]]

| valign="top" |

| valign="top" |

* [[ActorSerializeParameter and AI]]
* [[Data Table/Actor Parameters]]
* [[Enemy Parameters]]
* [[ActorGeneratorList]]

|-

! colspan="5" | Managers
|-
| valign="top" |
* [[BX file]] (Soundfont index)
* [[Pikmin pellet manager|Pellets]]
* [[Pikmin anim manager|Animations]]
* [[Pikmin teki manager|Tekis (DOL)]]
* [[Pikmin stage manager|Stage manager]]
* [[Pikmin stage information|Stage information / lighting]]

| valign="top" |
* [[AAF file]] (Soundfont index)
* Pellet List
** [[Pikmin 2 otakara_config.txt|Treasure Config]]
** [[Pikmin 2 item_config.txt|Item Config]]
** [[Pikmin 2 otakara_config.txt|Otakara Config]]
** [[Pikmin 2 carcass_config.txt|Carcass Config]]
** [[Pikmin 2 numberpellet_config.txt|Number Pellet Config]]
* [[Pikmin 2 animmgr.txt|Animation Manager]]
* [[Pikmin 2 collinfo.txt|Collision Info]]

* [[Mail Table]]

| valign="top" |

| valign="top" |

| valign="top" |

|-

! colspan="5" | Explanations and Notes
|-
| valign="top" |
* [[Pikmin unread files|Unread files]]
* [[Pikmin disable archives trick|Disable loading from archives]]
* [[Pikmin Emperor crash|Emperor crash]]
* [[Minty Ramblings]]
* [[Custom sequenced Pikmin music|Custom sequenced music]]

| valign="top" |
* [[Cave spawning]]
* [[Custom models]]
* [[Submerged Castle oddities|Special cave properties]]
* [[How Pikmin 2 loads text|How ''Pikmin 2'' loads text]]
* [[Sound Replacement Tutorial|Sound Replacement Tutorial]]
* [[Enemy Memory Usage]]
* [[Disassembly instructions]]
* [[Jsystem]]
* [[Pikmin 2 gEnemyInfo|gEnemyInfo]]
* [[Epoch Notes]]
* [[Cubes Yap Notes]]
* [[User:Captain Salty/Blo Editing Notes|Blo Editing Notes]]
* [[Cutscene Notes]]
* [[Creating Interactive BMS Files|Creating interactive area music]]
* [[Creating cave music|Creating interactive cave music]]

| valign="top" |
* [[Pikmin 3 oddities|Oddities]]
* [[Story mode maps in other modes]]
* [[Pikmin 3 Bingo Battle|Bingo Battle]]

| valign="top" |
* [[Hey! Pikmin unread files|Unread files]]

| valign="top" |
* Documentation
** [[Lilith's P4 Notes]]
** [[Pikmin 4 Demo Research]]
* Tutorials
** [[Model Importing Tutorial]]
** [[WEM Audio Modding Tutorial]]
** [[Enemy Duplication Tutorial (WIP)]]
|-

! colspan="5" | Tools
|-
| valign="top" |
* [[PikBinGen]]
* [[Archive Toolkit]]
* [[OpenGL / Dolphin System|OpenGL / Dolphin System]]

| valign="top" |
* [[Cave Creator]]
* [[Pikmin 2 Routes Editor & Gen Editor]]
* [[obj2grid]]
* [[DOL-Ckit]]
* [[Drought Enders Cave Creator]]
* [[SuperBMD]]
* [[pikminBMGtool]]
* [[btk-conv]]

| valign="top" |
* [[Gen Editor]]

| valign="top" |
* [[Hey! Pikmin stage viewer]]

| valign="top" |
* [[P4UassetEditor]]
* [[Modified FModel]]
* [[UCas/UToc Packer]]
* [[Dandori DB]]
* [[Dandori Desktop]]
* [[UE4LocalizationsTool]]

|}

== Tasks ==
* [[:Category:Pages with things to do|Things to do]]
* [[:Category:Pages with unsure information|Unsure info that needs to be confirmed]]

[[Category:PikminTKB]]

Creating Interactive BMS Files

2024-04-18T08:36:36Z

Waffles: extra troubleshooting

This guide will function as a walkthrough for creating interactive music for Pikmin 2's main areas. 

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be exporting each track of your MIDI separately as its own BMS file, and importing them one at a time.
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

Most of the editing will be done in hexadecimal. Creating [[Creating cave music|cave music]] is very similar.

== Preparing and exporting MIDIs ==
You will be exporting each track of your song as its own separate MIDI file, and then convert each MIDI into a mini BMS file of its own. 
If your song has 14 instruments, then you'll export 14 MIDIs. Make sure each track is the same length so that looping will work properly. 

For some reason, imported BMS files play exactly 4 times as slow in interactive music. So if you import the tracks as is, they will play 4 times as slow. 
Before you export them, you need to modify them to run 4 times as fast. Do not address this by changing the BPM in your DAW, you need to shorten the actual notes instead. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>
(Note: While you *can* technically just multiply the BPM value by 4 in the BMS later on, Louie's variant is dependent on the BPM being something normal, so the swing will not be applied properly if you do that.)

== Base BMS file ==
Starting from scratch, here is a base for you to work off of. In a hex editor, copy and paste this into a completely new, blank BMS file:
<pre>E74000A0 0003AC04 0104AA20 050400B1 C1400005 AC04010A AA200504 00B1C140 0105AC04 0110AA20 050400B1 C1400205 AC040116 AA200504 00B1C140 0305AC04 011CAA20 050400B1 C1400405 AC040122 AA200504 00B1C140 0505AC04 0128AA20 050400B1 C1400605 AC04012E AA200504 00B1C140 0705AC04 0134AA20 050400B1 C1400805 AC04013A AA200504 00B1C140 0905AC04 0140AA20 050400B1 C1400A05 AC040146 AA200504 00B1C140 0B05AC04 014CAA20 050400B1 C1400C05 AC040152 AA200504 00B1C140 0D05AC04 0158AA20 050400B1 C1400E05 AC04015E AA200504 00B1C140 0F05FE00 78FD0066 C8000001 9F884B00 C8000000 E9884B00 C8000000 F98001FF 0002AA00 071E0002 E600075A 00032200 07960003 5E0007D2 00039A00 080E0003 D600084A 00041200 08860004 4E0008C2 00048A00 08F30004 C600093A 00050200 09760005 3E0009B2 00057A00 09EE0005 B6000A2A 0005F200 0A660006 2E000AA2 C600E70E 00DF0700 018AE72E 00CF03C8 0000016E E70E00DF 0700018A E72E00CF 03C80000 0180E71E 00E3E700 00E70F00 DF070001 9BC600E7 1F00E3E7 0E00DF07 0001B9E7 4001C805 000000E7 2E00CF03 C8000001 A7E71E00 E74001C8 050001C5 E3E1C800 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 44617920 76657273 696F6E3A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000042 00004900 00560000 50000000 00000000 00000000 5365713A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000294C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0002D0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00030CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000348C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000384C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0003C0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0003FCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000438C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000474C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0004B0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0004ECC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000528C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000564C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0005A0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0005DCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000618C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 53756E73 65742076 65722E3A 00000020 20202000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000042 00004900 00560000 50000000 00000000 00000000 5365713A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000708C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000744C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000780C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0007BCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008F8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000834C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000870C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008ACC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008E8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000924C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000960C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00099CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0009D8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000A14C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000A50C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00058CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 FF000000 3C2D2028 4E756C6C 20747261 636B2061 74203078 30623034 2C20666F 7220616E 7920656D 70747920 74726163 6B732900 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 76767620 50617374 6520796F 75722073 65717565 6E636573 20686572 65212076 76760000 00000000 00000000 00000000 00000000 00000000 00000000</pre>

This file is setup with all the important information already filled out for you. You should resize the window so that you can see all 16 Day tracks and all 16 Sunset tracks evenly spaced on each line:

<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial1.png|You can use this image as a guide for the "mixer".
</gallery>

This section is sort of like a mixer; you can set the volume and stereo panning of each track. More importantly, you also choose the bank and program here. Most importantly, at the end of each track, you select what sequence the track uses. You just type in the offset of the sequence there.

== Importing sequences ==
=== Converting ===
Convert all your MIDIs into BMS files with [[Pikmin 2 custom music|flaaffy]]. You can use the following commands in the command line (make sure to include the "-loop" argument in the first command, so it knows to loop the sequence):

<pre>mareep.exe mareep -errand jolt -input exampletrack02.midi -output exampletrack02.txt -loop
mareep.exe mareep -errand cotton -input exampletrack02.txt -output exampletrack02.bms</pre>

Flaaffy turns the MIDI into a text file before it is converted into a BMS. The text file is "cotton", flaaffy's assembly language. Viewing the cotton file can be useful for double checking there's in fact only one track in each of your MIDIs. You will open each BMS file you make with flaaffy, and copy paste the hex data of each into the bottom of the Base BMS.

=== Copying and pasting ===
In your exported BMS, look for the instance of <code>A420</code> (if there are multiple, use the last occurrence of it). This A420 is what sets the bank of the sequence, and it will be followed by either a 00, 01, 02, 03, 04, or 05 after it. 

If you want to use bank 0, change it to <code>A42000</code>, if you want to use bank 4, change it to <code>A42004</code>, and so on. 

Copy <code>A420</code> and the entire remainder of the file, and paste everything into your Base BMS, anywhere at the bottom of it.

<gallery mode="packed-hover" widths=160px heights=160px>
File:InteractiveBMStutorial2.png|This is what you should copy. If your track has a lot of notes in it, this can be much longer.
</gallery>

<gallery mode="packed-hover" widths=220px heights=220px>
File:InteractiveBMStutorial3.png|This is how you should paste in the sequences.
</gallery>

You should paste each converted BMS on a new line, separated by an empty line of zeros so its easy to tell where each sequence begins.

=== Looping ===
Notice the <code>C80000XXXX</code> at the very end of the sequence you pasted in (the C80000 will be the same, but the numbers at the end will be different). The "XXXX" tells the sequence where the song loops and should restart at. Change XXXX to be where the sequence starts in the base BMS file. (Ex: do <code>C8000011D4</code> if the sequence starts at 0x11D4).

== Finishing touches ==
=== Fill in the mixer ===
After you have imported all the sequences, have made sure all the <code>A420</code>'s have the right bank, and looped them, go back to the mixer and fill in the appropriate information. (Bank, program, volume, panning, sequence location.) The "sequence location" will be the offset where each <code>A420</code> is.

(Note: You do not have to import the same sequence over and over again if there are any identical sequences; you are free to reference the same one sequence and just give them different instruments. This is useful for sunset versions or treasure mix instruments.)

=== Null track ===
If you don't want a track to play anything, have it go to the "null track" located at <code>0B04</code>. (If you look, it's just a single "FF", which is a sequence that ends immediately.) This is what each track is set to by default in the provided Base BMS.

=== Tempo ===
You don't have to touch anything in the header at the top of the Base BMS, except for changing the BPM. The BPM for your song is located at 0xEA and takes up two bytes. (Ex: "<code>0066</code>" for 102 BPM).

=== Padding ===
Add in an extra line of zeros or two at the end of your finished Base BMS, because it sometimes crashes if extra padding is not there.

=== trackMap ===
Make sure the tracks in the mixer go in order: Main -> Task -> Treasure -> Enemy near -> Battle -> Spiderwort. Same for the sunset version. 
Open the sequence trackMap in <code>/user/Wakai/</code>, find the song you are replacing (forest.bms, last.bms...), and [[Trackmap parameters|edit the values in the trackMap]] to reflect how many instruments will be in each mix. The main and sunset version will use the same mapping. You can make unnecessary tracks silent in the Base BMS's mixer if your sunset version has less instruments.

== Troubleshooting ==
=== Tracks not looping correctly ===
Make sure each track is exactly the same length. You can export your entire song as one MIDI, convert it to BMS, and import it into the game as an un-interactive BMS file just to check. Flaaffy is finicky with looping occasionally; you may need to add a note at the end or start of a track so flaaffy knows thats the definitive start/end point of that track. (Make the note very quiet, low-pitch, and or short so its practically inaudible.)

=== Tracks not looping at all ===
Double-check you added the -loop argument in flaaffy. Test with an un-interactive BMS file. Make sure there isn't any stray information somewhere in your MIDI.

=== Volume/panning/program settings not working ===
It is possible there is volume automation, panning automation, or program changes somewhere in your MIDI/BMS you have imported. This is something you can add intentionally if you really want to (like changing the program for a track in the middle of the song), but it will override the values you put in the mixer.

=== Missing/dropped notes ===
This is an another issue with flaaffy. If a "Note Off" also occurs at the same time a "Note On" does, or multiple "Note On"s occur at the exact same millisecond, flaaffy won't render these correctly. You might run into this often when instruments try to play chords. 

The simple fix for flaaffy is to make sure notes of the same pitch do not touch each other, and to slightly skew or slant the notes of chords.

<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial4.png|Make sure the notes in a chord don't occur at the same time.
</gallery>

Alternatively, JAIMaker does not run into this issue for its BMS conversions. If you decide to use it instead, you will need to be more precise about importing the data from the BMS files into the Base BMS.

File:InteractiveBMStutorial4.png

2024-04-18T08:28:54Z

Waffles: Image of flaaffy being kinda silly.

== Summary ==
Image of flaaffy being kinda silly.

Creating Interactive BMS Files

2024-04-18T08:16:04Z

Waffles: Troubleshooting

This guide will function as a walkthrough for creating interactive music for Pikmin 2's main areas. 

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be exporting each track of your MIDI separately as its own BMS file, and importing them one at a time.
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

Most of the editing will be done in hexadecimal. Creating [[Creating cave music|cave music]] is very similar.

== Preparing and exporting MIDIs ==
You will be exporting each track of your song as its own separate MIDI file, and then convert each MIDI into a mini BMS file of its own. 
If your song has 14 instruments, then you'll export 14 MIDIs. Make sure each track is the same length so that looping will work properly. 

For some reason, imported BMS files play exactly 4 times as slow in interactive music. So if you import the tracks as is, they will play 4 times as slow. 
Before you export them, you need to modify them to run 4 times as fast. Do not address this by changing the BPM in your DAW, you need to shorten the actual notes instead. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>
(Note: While you *can* technically just multiply the BPM value by 4 in the BMS later on, Louie's variant is dependent on the BPM being something normal, so the swing will not be applied properly if you do that.)

== Base BMS file ==
Starting from scratch, here is a base for you to work off of. In a hex editor, copy and paste this into a completely new, blank BMS file:
<pre>E74000A0 0003AC04 0104AA20 050400B1 C1400005 AC04010A AA200504 00B1C140 0105AC04 0110AA20 050400B1 C1400205 AC040116 AA200504 00B1C140 0305AC04 011CAA20 050400B1 C1400405 AC040122 AA200504 00B1C140 0505AC04 0128AA20 050400B1 C1400605 AC04012E AA200504 00B1C140 0705AC04 0134AA20 050400B1 C1400805 AC04013A AA200504 00B1C140 0905AC04 0140AA20 050400B1 C1400A05 AC040146 AA200504 00B1C140 0B05AC04 014CAA20 050400B1 C1400C05 AC040152 AA200504 00B1C140 0D05AC04 0158AA20 050400B1 C1400E05 AC04015E AA200504 00B1C140 0F05FE00 78FD0066 C8000001 9F884B00 C8000000 E9884B00 C8000000 F98001FF 0002AA00 071E0002 E600075A 00032200 07960003 5E0007D2 00039A00 080E0003 D600084A 00041200 08860004 4E0008C2 00048A00 08F30004 C600093A 00050200 09760005 3E0009B2 00057A00 09EE0005 B6000A2A 0005F200 0A660006 2E000AA2 C600E70E 00DF0700 018AE72E 00CF03C8 0000016E E70E00DF 0700018A E72E00CF 03C80000 0180E71E 00E3E700 00E70F00 DF070001 9BC600E7 1F00E3E7 0E00DF07 0001B9E7 4001C805 000000E7 2E00CF03 C8000001 A7E71E00 E74001C8 050001C5 E3E1C800 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 44617920 76657273 696F6E3A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000042 00004900 00560000 50000000 00000000 00000000 5365713A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000294C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0002D0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00030CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000348C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000384C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0003C0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0003FCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000438C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000474C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0004B0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0004ECC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000528C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000564C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0005A0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0005DCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000618C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 53756E73 65742076 65722E3A 00000020 20202000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000042 00004900 00560000 50000000 00000000 00000000 5365713A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000708C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000744C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000780C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0007BCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008F8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000834C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000870C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008ACC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008E8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000924C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000960C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00099CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0009D8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000A14C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000A50C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00058CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 FF000000 3C2D2028 4E756C6C 20747261 636B2061 74203078 30623034 2C20666F 7220616E 7920656D 70747920 74726163 6B732900 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 76767620 50617374 6520796F 75722073 65717565 6E636573 20686572 65212076 76760000 00000000 00000000 00000000 00000000 00000000 00000000</pre>

This file is setup with all the important information already filled out for you. You should resize the window so that you can see all 16 Day tracks and all 16 Sunset tracks evenly spaced on each line:

<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial1.png|You can use this image as a guide for the "mixer".
</gallery>

This section is sort of like a mixer; you can set the volume and stereo panning of each track. More importantly, you also choose the bank and program here. Most importantly, at the end of each track, you select what sequence the track uses. You just type in the offset of the sequence there.

== Importing sequences ==
=== Converting ===
Convert all your MIDIs into BMS files with [[Pikmin 2 custom music|flaaffy]]. You can use the following commands in the command line (make sure to include the "-loop" argument in the first command, so it knows to loop the sequence):

<pre>mareep.exe mareep -errand jolt -input exampletrack02.midi -output exampletrack02.txt -loop
mareep.exe mareep -errand cotton -input exampletrack02.txt -output exampletrack02.bms</pre>

Flaaffy turns the MIDI into a text file before it is converted into a BMS. The text file is "cotton", flaaffy's assembly language. Viewing the cotton file can be useful for double checking there's in fact only one track in each of your MIDIs. You will open each BMS file you make with flaaffy, and copy paste the hex data of each into the bottom of the Base BMS.

=== Copying and pasting ===
In your exported BMS, look for the instance of <code>A420</code> (if there are multiple, use the last occurrence of it). This A420 is what sets the bank of the sequence, and it will be followed by either a 00, 01, 02, 03, 04, or 05 after it. 

If you want to use bank 0, change it to <code>A42000</code>, if you want to use bank 4, change it to <code>A42004</code>, and so on. 

Copy <code>A420</code> and the entire remainder of the file, and paste everything into your Base BMS, anywhere at the bottom of it.

<gallery mode="packed-hover" widths=160px heights=160px>
File:InteractiveBMStutorial2.png|This is what you should copy. If your track has a lot of notes in it, this can be much longer.
</gallery>

<gallery mode="packed-hover" widths=220px heights=220px>
File:InteractiveBMStutorial3.png|This is how you should paste in the sequences.
</gallery>

You should paste each converted BMS on a new line, separated by an empty line of zeros so its easy to tell where each sequence begins.

=== Looping ===
Notice the <code>C80000XXXX</code> at the very end of the sequence you pasted in (the C80000 will be the same, but the numbers at the end will be different). The "XXXX" tells the sequence where the song loops and should restart at. Change XXXX to be where the sequence starts in the base BMS file. (Ex: do <code>C8000011D4</code> if the sequence starts at 0x11D4).

== Finishing touches ==
=== Fill in the mixer ===
After you have imported all the sequences, have made sure all the <code>A420</code>'s have the right bank, and looped them, go back to the mixer and fill in the appropriate information. (Bank, program, volume, panning, sequence location.) The "sequence location" will be the offset where each <code>A420</code> is.

(Note: You do not have to import the same sequence over and over again if there are any identical sequences; you are free to reference the same one sequence and just give them different instruments. This is useful for sunset versions or treasure mix instruments.)

=== Null track ===
If you don't want a track to play anything, have it go to the "null track" located at <code>0B04</code>. (If you look, it's just a single "FF", which is a sequence that ends immediately.) This is what each track is set to by default in the provided Base BMS.

=== Tempo ===
You don't have to touch anything in the header at the top of the Base BMS, except for changing the BPM. The BPM for your song is located at 0xEA and takes up two bytes. (Ex: "<code>0066</code>" for 102 BPM).

=== Padding ===
Add in an extra line of zeros or two at the end of your finished Base BMS, because it sometimes crashes if extra padding is not there.

=== trackMap ===
Make sure the tracks in the mixer go in order: Main -> Task -> Treasure -> Enemy near -> Battle -> Spiderwort. Same for the sunset version. 
Open the sequence trackMap in <code>/user/Wakai/</code>, find the song you are replacing (forest.bms, last.bms...), and [[Trackmap parameters|edit the values in the trackMap]] to reflect how many instruments will be in each mix. The main and sunset version will use the same mapping. You can make unnecessary tracks silent in your mixer if your sunset version has less instruments.

== Troubleshooting ==
=== Tracks not looping correctly ===
Make sure each track is exactly the same length. You can export your entire song as one MIDI, convert it to BMS, and import it into the game as an un-interactive BMS file just to check. Flaaffy is finicky with looping occasionally; you may need to add a note at the end or start of a track so flaaffy knows thats the definitive start/end of that track. (Make the note very quiet, low-pitch, and or short so its practically inaudible.)

=== Tracks not looping at all ===
Double-check you added the -loop argument in flaaffy. Test with an un-interactive BMS file. Make sure there isn't any stray information somewhere in your MIDI.

=== Volume/panning/program settings not working ===
It is possible there is volume automation, panning automation, or program changes somewhere in your MIDI/BMS you have imported. This is something you can do intentionally if you really want to (like changing the program for a track in the middle of the song), but it will override the values you put in the mixer.

Creating Interactive BMS Files

2024-04-18T08:05:06Z

Waffles: Major overhaul

This guide will function as a walkthrough for creating interactive music for Pikmin 2's main areas. 

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be exporting each track of your MIDI separately as its own BMS file, and importing them one at a time.
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

Most of the editing will be done in hexadecimal. Creating [[Creating cave music|cave music]] is very similar.

== Preparing and exporting MIDIs ==
You will be exporting each track of your song as its own separate MIDI file, and then convert each MIDI into a mini BMS file of its own. 
If your song has 14 instruments, then you'll export 14 MIDIs. Make sure each track is the same length so that looping will work properly. 

For some reason, imported BMS files play exactly 4 times as slow in interactive music. So if you import the tracks as is, they will play 4 times as slow. 
Before you export them, you need to modify them to run 4 times as fast. Do not address this by changing the BPM in your DAW, you need to shorten the actual notes instead. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>
(Note: While you *can* technically just multiply the BPM value by 4 in the BMS later on, Louie's variant is dependent on the BPM being something normal, so the swing will not be applied properly if you do that.)

== Base BMS file ==
Starting from scratch, here is a base for you to work off of. In a hex editor, copy and paste this into a completely new, blank BMS file:
<pre>E74000A0 0003AC04 0104AA20 050400B1 C1400005 AC04010A AA200504 00B1C140 0105AC04 0110AA20 050400B1 C1400205 AC040116 AA200504 00B1C140 0305AC04 011CAA20 050400B1 C1400405 AC040122 AA200504 00B1C140 0505AC04 0128AA20 050400B1 C1400605 AC04012E AA200504 00B1C140 0705AC04 0134AA20 050400B1 C1400805 AC04013A AA200504 00B1C140 0905AC04 0140AA20 050400B1 C1400A05 AC040146 AA200504 00B1C140 0B05AC04 014CAA20 050400B1 C1400C05 AC040152 AA200504 00B1C140 0D05AC04 0158AA20 050400B1 C1400E05 AC04015E AA200504 00B1C140 0F05FE00 78FD0066 C8000001 9F884B00 C8000000 E9884B00 C8000000 F98001FF 0002AA00 071E0002 E600075A 00032200 07960003 5E0007D2 00039A00 080E0003 D600084A 00041200 08860004 4E0008C2 00048A00 08F30004 C600093A 00050200 09760005 3E0009B2 00057A00 09EE0005 B6000A2A 0005F200 0A660006 2E000AA2 C600E70E 00DF0700 018AE72E 00CF03C8 0000016E E70E00DF 0700018A E72E00CF 03C80000 0180E71E 00E3E700 00E70F00 DF070001 9BC600E7 1F00E3E7 0E00DF07 0001B9E7 4001C805 000000E7 2E00CF03 C8000001 A7E71E00 E74001C8 050001C5 E3E1C800 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 44617920 76657273 696F6E3A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000042 00004900 00560000 50000000 00000000 00000000 5365713A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000294C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0002D0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00030CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000348C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000384C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0003C0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0003FCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000438C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000474C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0004B0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0004ECC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000528C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000564C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0005A0C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0005DCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000618C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 53756E73 65742076 65722E3A 00000020 20202000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000042 00004900 00560000 50000000 00000000 00000000 5365713A 00000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000708C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000744C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000780C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0007BCC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008F8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000834C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000870C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008ACC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0008E8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000924C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000960C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00099CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 0009D8C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000A14C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 000A50C8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 C4000001 8EA42004 A4212C98 007F9A03 400AC600 0000C400 00058CC8 00000B04 FF000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 FF000000 3C2D2028 4E756C6C 20747261 636B2061 74203078 30623034 2C20666F 7220616E 7920656D 70747920 74726163 6B732900 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 76767620 50617374 6520796F 75722073 65717565 6E636573 20686572 65212076 76760000 00000000 00000000 00000000 00000000 00000000 00000000</pre>

This file is setup with all the important information already filled out for you. You should resize the window so that you can see all 16 Day tracks and all 16 Sunset tracks evenly spaced on each line:

<gallery mode="packed-hover" widths=400px heights=400px>
File:InteractiveBMStutorial1.png|You can use this image as a guide for the "mixer".
</gallery>

This section is sort of like a mixer; you can set the volume and stereo panning of each track. More importantly, you also choose the bank and program here. Most importantly, at the end of each track, you select what sequence the track uses. You just type in the offset of the sequence there.

== Importing sequences ==
=== Converting ===
Convert all your MIDIs into BMS files with [[Pikmin 2 custom music|flaaffy]]. You can use the following commands in the command line (make sure to include the "-loop" argument in the first command, so it knows to loop the sequence):

<pre>mareep.exe mareep -errand jolt -input exampletrack02.midi -output exampletrack02.txt -loop
mareep.exe mareep -errand cotton -input exampletrack02.txt -output exampletrack02.bms</pre>

Flaaffy turns the MIDI into a text file before it is converted into a BMS. The text file is "cotton", flaaffy's assembly language. Viewing the cotton file can be useful for double checking there's in fact only one track in each of your MIDIs. You will open each BMS file you make with flaaffy, and copy paste the hex data of each into the bottom of the Base BMS.

=== Copying and pasting ===
In your exported BMS, look for the instance of <code>A420</code> (if there are multiple, use the last occurrence of it). This A420 is what sets the bank of the sequence, and it will be followed by either a 00, 01, 02, 03, 04, or 05 after it. 

If you want to use bank 0, change it to <code>A42000</code>, if you want to use bank 4, change it to <code>A42004</code>, and so on. 

Copy <code>A420</code> and the entire remainder of the file, and paste everything into your Base BMS, anywhere at the bottom of it.

<gallery mode="packed-hover" widths=160px heights=160px>
File:InteractiveBMStutorial2.png|This is what you should copy. If your track has a lot of notes in it, this can be much longer.
</gallery>

<gallery mode="packed-hover" widths=220px heights=220px>
File:InteractiveBMStutorial3.png|This is how you should paste in the sequences.
</gallery>

You should paste each converted BMS on a new line, separated by an empty line of zeros so its easy to tell where each sequence begins.

=== Looping ===
Notice the <code>C80000XXXX</code> at the very end of the sequence you pasted in (the C80000 will be the same, but the numbers at the end will be different). The "XXXX" tells the sequence where the song loops and should restart at. Change XXXX to be where the sequence starts in the base BMS file. (Ex: do <code>C8000011D4</code> if the sequence starts at 0x11D4).

== Finishing touches ==
=== Fill in the mixer ===
After you have imported all the sequences, have made sure all the <code>A420</code>'s have the right bank, and looped them, go back to the mixer and fill in the appropriate information. (Bank, program, volume, panning, sequence location.) The "sequence location" will be the offset where each <code>A420</code> is.

(Note: You do not have to import the same sequence over and over again if there are any identical sequences; you are free to reference the same one sequence and just give them different instruments. This is useful for sunset versions or treasure mix instruments.)

=== Null track ===
If you don't want a track to play anything, have it go to the "null track" located at <code>0B04</code>. (If you look, it's just a single "FF", which is a sequence that ends immediately.) This is what each track is set to by default in the Base BMS.

=== Tempo ===
You don't have to touch anything in the header at the top of the Base BMS, except for changing the BPM. The BPM for your song is located at 0xEA and takes up two bytes. (Ex: "<code>0066</code>" for 102 BPM).

=== Padding ===
Add in an extra line of zeros or two at the end of your finished Base BMS, because it sometimes crashes if extra padding is not there.

=== trackMap ===
Make sure the tracks in the mixer go in order: Main -> Task -> Treasure -> Enemy near -> Battle -> Spiderwort. Same for the sunset version. 
Open the sequence trackMap in <code>/user/Wakai/</code>, find the song you are replacing (forest.bms, last.bms...), and [[Trackmap parameters|edit the values in the trackMap]] to reflect how many instruments will be in each mix. The main and sunset version will use the same mapping. You can make unnecessary tracks silent in your mixer if your sunset version has less instruments.

File:InteractiveBMStutorial3.png

2024-04-18T07:57:48Z

Waffles: Waffles uploaded a new version of File:InteractiveBMStutorial3.png

== Summary ==
Tutorial for interactive BMS files.

File:InteractiveBMStutorial3.png

2024-04-18T07:41:52Z

Waffles: Tutorial for interactive BMS files.

== Summary ==
Tutorial for interactive BMS files.

File:InteractiveBMStutorial2.png

2024-04-18T07:41:37Z

Waffles: Tutorial for interactive BMS files.

== Summary ==
Tutorial for interactive BMS files.

File:InteractiveBMStutorial1.png

2024-04-18T07:31:10Z

Waffles: Tutorial image for the Interactive BMS guide.

== Summary ==
Tutorial image for the Interactive BMS guide.

Creating cave music

2024-04-16T13:47:01Z

Waffles: /* Bonus: Adding gesture cutoffs in timetables */

Randomly generating cave music in Pikmin 2 needs to have two files: a .bms (sequence) file, and a .cnd (conductor) file.

The BMS file type is a sequenced music format used in many games. For the cave music in Pikmin 2 however, it is specially-formatted. It mainly contains many short snippets of musical information to be randomized.

The CND files are the actual "songs"; they take specific groups of snippets from a BMS file, and endlessly puzzle-piece them together to form a coherent piece of music.

This guide will function as a walkthrough for creating your own randomly sequencing cave song. All of the editing will be done in hexadecimal.

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be generating a lot of tiny BMS files, to turn them into "gestures".
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

== Overview of file functions ==
Here are some infographics that you can reference at any time. These show all the functions of a CND file, and all the contents of a BMS file.
<gallery mode="packed-hover" widths=250px heights=250px>
File:CND_functions.png|Conductor file functions.
File:BMS_functions.png|How information is stored in a BMS file.
</gallery>

== Setting up your BMS file ==
Before you begin, set your byte grouping to "3", so every 3 bytes is visually separated by a space. This will make it easier to see stuff. 
Starting with a completely blank BMS file, begin by pasting the following:
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600
</source>
Every cave music BMS begins with this same information, and will go mostly untouched.
 
 

== Gesture set list ==
Exactly right after <code>34C600</code> will be a list of every gesture set's location in the BMS. Each entry is the gesture set's hexadecimal location (offset), and each entry in the sequence begins with "<code>00</code>". <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0001B0 0001BF 0001CE 0001D4 0001DA 0001E9 0001F8 0001FE 000204 00020A FFFFFF</code> 
Gesture set "0" will be at offset <code>0x1B0</code>, gesture set "1" will be at offset <code>0x1BF</code>, gesture set "2" will be at <code>0x1CE</code>, and so on. There are a total of 10 gesture sets listed in the above sequence.
 
Until we create our gesture sets, let's use <code>00AAAA</code> as placeholders so we can easily find and get back to this section later on. You can have as many gesture sets as you like; we'll create 16 entries for this tutorial. You may insert this into your BMS: 
<code>00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF</code> 
 
Our BMS should now currently look like this: 
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000
</source>
You can also add an entire row of padding/zeros after this. You can do this for each section, to better visually separate them.
 

== Timing ruleset list ==
This is another sequence of offsets. These just point to the location of a "[[#Inserting_timetables|timetable]]", which will be located at the end of our BMS file. <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0005AB 0005AB 0005AF 0005C1 0005AB 0005AB 0005C1 0005C1 0005C1 0005C1 FFFFFF</code> 
Timing ruleset "0" will use the timetable at <code>0x5AB</code>, timing ruleset "1" will also use the timetable at <code>0x5AB</code>, timing ruleset "2" will use the timetable at <code>0x5AF</code>, and so on. There are a total of 10 timing rulesets listed in the above sequence.
 
Let's use <code>00BBBB</code> as placeholders again, and create 16 of them. Insert this anywhere into your BMS: 
<code>00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB FFFFFF</code> 
 

== Gesture set contents ==
A ''gesture set'' is a group of many gestures. 
Here, we list each gesture set's contents (which will be... the locations of the gestures!). Each gesture set begins before with <code>00</code> and ends with <code>FFFFFF</code>. 
Here is an example of how the gesture set list should be formatted: 
<code>000210 00022A 000258 000281 FFFFFF 0002B4 0002D9 000303 000331 FFFFFF 000355 FFFFFF 000361 FFFFFF 0003A8 0003C2 0003F0 000419 FFFFFF 00044C 000471 00049B 0004C9 FFFFFF 0004ED FFFFFF 000543 FFFFFF 000580 FFFFFF 00059E FFFFFF</code> 
There are 10 gesture sets listed above. The first gesture set has 4 gestures, located at <code>0x210</code>, <code>0x22A</code>, <code>0x258</code>, and <code>0x281</code>. You can have any amount of gestures in a gesture set; even 1 is fine.
 
You can paste the following placeholder information for now: 
<code>00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC FFFFFF</code> 
It might be a good idea to leave a decent amount of zeros after this list; this one will expand a lot as gestures and gesture sets are added to it.
 

== How is your BMS looking? ==
If you have been copy-pasting everything correctly, your BMS will look something like this:
<gallery mode="packed-hover" widths=300px heights=300px>
File:BMS_file_progress_1.png|Orange is "gesture set list", yellow is "timing ruleset list", and blue is "gesture set contents"
</gallery>
Once again, you can add as much padding between each section as you want, it will work fine.

== Creating gestures ==
First, you should sketch out your song idea in your DAW, and then cut your song into tiny blocks. These blocks will be your song's individual gestures. You should also consider dragging these blocks around in various arrangements to make sure they sound good in any order. 
Once you are ready, have them nicely organized and ready to be exported into individual MIDI files:
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_Pro_gestures.png|A Logic Pro project with a bunch of short blocks of music. Each block will be a "gesture".
</gallery>
For some reason, imported BMS files play 4 times as slow in cave songs. So if you import these gestures as is, they will play 4 times as slow. 
Before you export your gestures, you need to modify your gestures to run ''4 times as fast''. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each block.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>

== Inserting gestures ==
Gestures use same the note/music information as standard BMS songs. 

You should have converted all your MIDIs into BMS files. Open up one of your converted BMS files, and look for the first note/pitch value. If you used [[Pikmin 2 custom music|flaaffy]], this will most likely be somewhere after <code>0x1B</code>, <code>0x1C</code>, or <code>0x1D</code>. The note's pitch value will often be followed by a <code>01</code>, then the velocity value. Copy this note, all the way to the end of the sequence, which should be <code>FF</code>.
<gallery mode="packed-hover" widths=600px>
File:Copy_pasting_BMS_info.png|The value "2D" here is the hex value of a certain pitch, and the very first note of the sequence. Copy this, all the way to "FF".
</gallery>
To add your gesture, start it with <code>C40000015D</code>, then paste in what you copied. Each gesture should end with that <code>FF</code>. Add as many gestures as you please!
<gallery mode="packed-hover" widths=400px heights=400px>
File:BMS_file_progress_2.png|The purple lines indicate where a gesture starts.
</gallery>

== Inserting timetables ==
So, how do we choose how often gestures will play? Will a gesture play every beat? Every 1/2 a beat? You will need to add a timetable for that!
A timetable is a sequence that dictates when gestures should play. A timetable ends with <code>FFFF</code>. You can make a timetable as complex as you like. Some examples of timetables you can use are: 
* <code>0780FFFF</code> Play a gesture every 16 beats. 
* <code>03C0FFFF</code> Play a gesture every 8 beats. 
* <code>01E0FFFF</code> Play a gesture every 4 beats. 
* <code>03C003C003C001E001E001E001E003C0FFFF</code> This sequence will play a gesture every 8 beats (3x), play a gesture every 4 beats (4x), then play a gesture for 8 beats (1x), in that order. 
* <code>00F0FFFF</code> Play a gesture every 1/2 note (every 2 beats). 
* <code>0078FFFF</code> Play a gesture every 1/4 note (every beat). 
* <code>003CFFFF</code> Play a gesture every 1/8th note. 
* <code>001EFFFF</code> Play a gesture every 1/16th note. 
* <code>003C0078001EFFFF</code> This sequence will play a gesture for an 1/8th note, play a gesture for a 1/4 note, then play a gesture for a 1/16th note, in that order. 
Considering that <code>001E</code> (30 in decimal) is a 1/16th note, you can create any specific timing you want. Just add another 30 to the value for each additional sixteenth note in length. 
For example, Soil 1's enemy mix piano plays very rapidly; its timetable uses a value of 90, which looks like <code>005AFFFF</code>. The gestures last for three sixteenth notes. 
You can insert your timetables anywhere at the end of your BMS.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_3.png|Each timetable has a pink box around it.
</gallery>

== Filling in info ==
Once you have your gestures and timetables inserted, go back and fill in those <code>00AAAA</code>, <code>00BBBB</code>, <code>00CCCC</code> placeholders with the locations of your gesture sets, timetables, and gestures you want to use. Remember that gesture sets begin with the <code>00</code>.

Also in the very beginning of your BMS, make sure the value at <code>0x6</code> has the location of where your gesture set list begins (this one will probably be fine), and the value at <code>0x14</code> has the location of where your timing ruleset list begins.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_4.png|Put the location of where the "timing ruleset list" begins here.
</gallery>

== Filling in the conductor file ==
<gallery mode="packed-hover" widths=500px heights=500px>
File:CND_functions.png|Conductor file functions.
</gallery>
In your song's associated conductor file, try to stretch out the window so that the instrument names are all in the same column if you can, like in the image above. 
Each line represents one track. You give each track a instrument (program), and what gesture set and timing ruleset to use. 
The CND infographic above does a good job explaining all the functions, but they'll be explained again down here. 

In the top left corner are three important values:
* The first value is the swing time. <code>1E</code> is 1/16th swing, while <code>3C</code> is 1/8th swing. If your song is below 100bpm, you might want to use <code>1E</code>. If its faster, try <code>3C</code> instead.
* The second value is the tempo, in hex.
* The third value is how many tracks there will be, in hex.

Each column explained:
* A: Initial delay. How many beats until this track starts running. In the vanilla game, you can notice how some song's melodies do not immediately begin playing upon the start of level. This is useful for that; ease the listener into the music.
* B/Q: If set to 1, all gestures will be delayed by an 1/8th note..
* C: Text string. You can make this say whatever you like. Useful for keeping track of what you want each track to be, like "Lead", "Trumpet", "MelodyA"/"MelodyB", "Bass", or "Drums"
* D: Track copy. Select a previous track # to copy the gestures from. If the track its copying plays "gesture 3" from its gesture set, this track will also play its "gesture 3". Often used for treasure mix instruments. You can have them use different gesture sets if you like.
* E: Echo strength.
* F: If set to 1, the values in this track's timetable will always be played in order, in a loop. If set to 0, it will randomly select values from its timetable, thus, allowing you to randomize when gestures play.
* G: Bank number.
* H: Program number. For a list of all programs in the default game and the wScenes that support them, view [[Pikmin 2 custom_music/available instruments|this page]].
* I: Gesture set, select the set # you want to use from the BMS.
* J: Timing ruleset, select the set # you want to use from the BMS.
* K: How many gestures this track will play, before playing "silent gestures". Linked to below. These function as a sort of on/off cycle.
* L: How many "silent gestures" this track will play, before playing normal gestures. Linked to above. These function as a sort of on/off cycle.
* M: If notes are being transposed down (see below), this is set to FF. But this column doesn't actually do anything, so you don't need to edit this.
* N: Transpose all notes played by this track. To transpose up, use values 1-127. To transpose down, use the sign 2 compliment (values 128-255).
* O: Volume.
* P: Stereo panning.
 
Some ideas/considerations:
* You can use the on/off cycle feature (column K and L) to make your melodic instrument "take a break" every once in a while. You can have it play 4 gestures, but then be silent for 2.
* If your timing ruleset is strict (as in, the timings for when gestures occur is always consistent), something fun to try is to have the melody be a back-and-forth between two different instruments. Set the initial delay for the second instrument to be longer than the first one, and then cleverly use the on/off cycle to have the instruments take turns sounding a gesture. This is done for the melody in the Bulblax Kingdom and Frontier Cavern for example.
* If you are using the "track copy" feature (column D), you can have the primary instrument play a melody, and have this instrument always play chords that perfectly match that melody.

== Mapping the tracks ==
With all that done, don't forget to edit the song's [[Trackmap parameters|trackMap]]! Edit your song in the trackMap files in either <code>/user/Totaka</code> or <code>/user/Wakai</code>, and set how many instruments will be in each mix. It goes in order from: Main Mix, Task (event), Treasure (otakara), Enemy near (kehai), Combat mix, and Spiderwort mix (ground). Although you cannot find Spiderworts underground, you will have to sacrifice at least one track for that mix. You cannot set any of the mixes to have 0 instruments in them.

== Bonus: Filenames for brand new CND files ==
If you are adding a brand new CND file instead of replacing an existing one, the prefix will determine which BMS is loaded, and which wScene. Try not to add special characters to filenames, aside from underscores. 

In order to load the correct BMS file, the CND must start with the name of the BMS file.
* "caveconc.cnd", "caveconc_458435.cnd", "caveconc_Waffles.cnd", and "caveconc_Waffles_Song_2.cnd" will all load caveconc.bms. 
* "caverelax.cnd", "caverelax_Gmajor.cnd", and "caverelax_mamuta_dinner.cnd" will all load caverelax.bms. 
* "new_09_4.cnd", "new_09_4000.cnd", and "new_09_portal_PotaTOS.cnd" will load new_09.bms. 

For cavesoil, caveconc, and cavemetal only, the game also checks for an additional "_00", "_05", and "_10" right after the prefix, for the purpose of loading one of three different wScenes. You must include it if you want the correct wScene to load. For example, caveconc_05 loads wScene 31, so if you want your custom song to also load wScene 31, acceptable names include "caveconc_05_WAFFLES.cnd", "caveconc_05_52_46356.cnd", or "caveconc_05_super_boss.cnd". 

After adding your new CND file, be sure to add it to its respective trackMap file.

== Bonus: Adding new content to a vanilla BMS file ==
Adding new hex data in the middle of a file will shift all the offsets that come after it, causing your BMS to jump to the wrong locations, and likely cause a crash if vanilla songs are loaded. 
In order to add new content in addition to what's already in the BMS:
* Find and copy the gesture set list and the timing ruleset list, and paste them at the end of the file. (Separate them with lots of zeros so you have lots more space to add content to these lists)
* Change <code>0x6</code> and <code>0x14</code> to point to your new gesture set list and timing ruleset list. These two values tell the game where the lists are.
The game should now use these brand new lists, instead of the original instances that occur earlier in the file. Since they still contain all the locations of the vanilla gesture sets/timetables from above in the same order, the existing CND songs won't be affected and will continue to function, but now you can expand upon these lists with brand new entries now that you've made the space for them. All new gestures, gesture sets and timetables can be added further down the file.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Editing_vanilla_BMS_file.png|The new gesture set list and timing ruleset list we want to use will be at the bottom.
</gallery>

== Bonus: Adding gesture cutoffs in timetables ==
An intentional compositional choice in some songs is to cutoff gestures while they're in the middle of playing. The most common way this is done is to quickly trigger another gesture; if the last gesture has not finished playing, it will stop playing that gesture and begin playing the new one. It's also possible to add "empty" gestures to gesture sets (like <code>C40000015DFF</code>, a gesture which ends immediately and plays nothing), so you can randomly interrupt gestures in your song with silence, or have there be a chance to play nothing. 
However, if you wish to interrupt gestures in your song at specified times without the randomness, there is a special function in timetables for doing this. In the vanilla game, this is used for the trumpet in [https://www.youtube.com/watch?v=qOhmS1YLpF8 Fire]. The trumpet plays two interrupted gestures, then plays a third gesture in full. Below is the timetable for this trumpet: 
<code>0078 8168 81E0 00F0 80F0 81E0 0780 FFFF</code> 
The trumpet will:
* <code>0078</code> play a gesture for 1 beat
* <code>8168</code> cutoff after this 1 beat
* <code>81E0</code> extend the silence for another 4 beats
* <code>00F0</code> play a gesture for 2 beats
* <code>80F0</code> cutoff after these 2 beats
* <code>81E0</code> extend the silence for another 4 beats
* <code>0780</code> play a gesture for 16 beats. 
In order to put a "cutoff" in your timetable:
* Start with how long you want your "playing" gesture to play for, before it gets cutoff. I want the the first gesture to last for one beat (four 1/16th notes), so I'll put <code>0078</code>. Remember that every "30" in decimal is equivalent to a sixteenth note.
* Immediately next in the sequence will be a value that indicates when the cutoff begins. Calculate the difference between "81E0" and the previous value you had just inserted. 81E0 - 0078 = 8168 (in decimal, 33248 - 120 = 33128). I will put <code>8168</code> next in my sequence.
My sequence is now <code>0078 8168 FFFF</code>; this will play a gesture normally for 1 beat, but then immediately cut it off after that 1 beat. 
Putting an additional <code>81E0</code> in the sequence right after will extend the silence for another 4 beats if you so desire. You can keep putting <code>81E0</code> right after several times in a row if you want silence to last extra long until the next gesture plays.

[[Category:Pikmin 2]]

Creating cave music

2024-04-16T13:37:21Z

Waffles: /* Inserting gestures */

Randomly generating cave music in Pikmin 2 needs to have two files: a .bms (sequence) file, and a .cnd (conductor) file.

The BMS file type is a sequenced music format used in many games. For the cave music in Pikmin 2 however, it is specially-formatted. It mainly contains many short snippets of musical information to be randomized.

The CND files are the actual "songs"; they take specific groups of snippets from a BMS file, and endlessly puzzle-piece them together to form a coherent piece of music.

This guide will function as a walkthrough for creating your own randomly sequencing cave song. All of the editing will be done in hexadecimal.

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be generating a lot of tiny BMS files, to turn them into "gestures".
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

== Overview of file functions ==
Here are some infographics that you can reference at any time. These show all the functions of a CND file, and all the contents of a BMS file.
<gallery mode="packed-hover" widths=250px heights=250px>
File:CND_functions.png|Conductor file functions.
File:BMS_functions.png|How information is stored in a BMS file.
</gallery>

== Setting up your BMS file ==
Before you begin, set your byte grouping to "3", so every 3 bytes is visually separated by a space. This will make it easier to see stuff. 
Starting with a completely blank BMS file, begin by pasting the following:
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600
</source>
Every cave music BMS begins with this same information, and will go mostly untouched.
 
 

== Gesture set list ==
Exactly right after <code>34C600</code> will be a list of every gesture set's location in the BMS. Each entry is the gesture set's hexadecimal location (offset), and each entry in the sequence begins with "<code>00</code>". <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0001B0 0001BF 0001CE 0001D4 0001DA 0001E9 0001F8 0001FE 000204 00020A FFFFFF</code> 
Gesture set "0" will be at offset <code>0x1B0</code>, gesture set "1" will be at offset <code>0x1BF</code>, gesture set "2" will be at <code>0x1CE</code>, and so on. There are a total of 10 gesture sets listed in the above sequence.
 
Until we create our gesture sets, let's use <code>00AAAA</code> as placeholders so we can easily find and get back to this section later on. You can have as many gesture sets as you like; we'll create 16 entries for this tutorial. You may insert this into your BMS: 
<code>00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF</code> 
 
Our BMS should now currently look like this: 
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000
</source>
You can also add an entire row of padding/zeros after this. You can do this for each section, to better visually separate them.
 

== Timing ruleset list ==
This is another sequence of offsets. These just point to the location of a "[[#Inserting_timetables|timetable]]", which will be located at the end of our BMS file. <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0005AB 0005AB 0005AF 0005C1 0005AB 0005AB 0005C1 0005C1 0005C1 0005C1 FFFFFF</code> 
Timing ruleset "0" will use the timetable at <code>0x5AB</code>, timing ruleset "1" will also use the timetable at <code>0x5AB</code>, timing ruleset "2" will use the timetable at <code>0x5AF</code>, and so on. There are a total of 10 timing rulesets listed in the above sequence.
 
Let's use <code>00BBBB</code> as placeholders again, and create 16 of them. Insert this anywhere into your BMS: 
<code>00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB FFFFFF</code> 
 

== Gesture set contents ==
A ''gesture set'' is a group of many gestures. 
Here, we list each gesture set's contents (which will be... the locations of the gestures!). Each gesture set begins before with <code>00</code> and ends with <code>FFFFFF</code>. 
Here is an example of how the gesture set list should be formatted: 
<code>000210 00022A 000258 000281 FFFFFF 0002B4 0002D9 000303 000331 FFFFFF 000355 FFFFFF 000361 FFFFFF 0003A8 0003C2 0003F0 000419 FFFFFF 00044C 000471 00049B 0004C9 FFFFFF 0004ED FFFFFF 000543 FFFFFF 000580 FFFFFF 00059E FFFFFF</code> 
There are 10 gesture sets listed above. The first gesture set has 4 gestures, located at <code>0x210</code>, <code>0x22A</code>, <code>0x258</code>, and <code>0x281</code>. You can have any amount of gestures in a gesture set; even 1 is fine.
 
You can paste the following placeholder information for now: 
<code>00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC FFFFFF</code> 
It might be a good idea to leave a decent amount of zeros after this list; this one will expand a lot as gestures and gesture sets are added to it.
 

== How is your BMS looking? ==
If you have been copy-pasting everything correctly, your BMS will look something like this:
<gallery mode="packed-hover" widths=300px heights=300px>
File:BMS_file_progress_1.png|Orange is "gesture set list", yellow is "timing ruleset list", and blue is "gesture set contents"
</gallery>
Once again, you can add as much padding between each section as you want, it will work fine.

== Creating gestures ==
First, you should sketch out your song idea in your DAW, and then cut your song into tiny blocks. These blocks will be your song's individual gestures. You should also consider dragging these blocks around in various arrangements to make sure they sound good in any order. 
Once you are ready, have them nicely organized and ready to be exported into individual MIDI files:
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_Pro_gestures.png|A Logic Pro project with a bunch of short blocks of music. Each block will be a "gesture".
</gallery>
For some reason, imported BMS files play 4 times as slow in cave songs. So if you import these gestures as is, they will play 4 times as slow. 
Before you export your gestures, you need to modify your gestures to run ''4 times as fast''. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each block.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>

== Inserting gestures ==
Gestures use same the note/music information as standard BMS songs. 

You should have converted all your MIDIs into BMS files. Open up one of your converted BMS files, and look for the first note/pitch value. If you used [[Pikmin 2 custom music|flaaffy]], this will most likely be somewhere after <code>0x1B</code>, <code>0x1C</code>, or <code>0x1D</code>. The note's pitch value will often be followed by a <code>01</code>, then the velocity value. Copy this note, all the way to the end of the sequence, which should be <code>FF</code>.
<gallery mode="packed-hover" widths=600px>
File:Copy_pasting_BMS_info.png|The value "2D" here is the hex value of a certain pitch, and the very first note of the sequence. Copy this, all the way to "FF".
</gallery>
To add your gesture, start it with <code>C40000015D</code>, then paste in what you copied. Each gesture should end with that <code>FF</code>. Add as many gestures as you please!
<gallery mode="packed-hover" widths=400px heights=400px>
File:BMS_file_progress_2.png|The purple lines indicate where a gesture starts.
</gallery>

== Inserting timetables ==
So, how do we choose how often gestures will play? Will a gesture play every beat? Every 1/2 a beat? You will need to add a timetable for that!
A timetable is a sequence that dictates when gestures should play. A timetable ends with <code>FFFF</code>. You can make a timetable as complex as you like. Some examples of timetables you can use are: 
* <code>0780FFFF</code> Play a gesture every 16 beats. 
* <code>03C0FFFF</code> Play a gesture every 8 beats. 
* <code>01E0FFFF</code> Play a gesture every 4 beats. 
* <code>03C003C003C001E001E001E001E003C0FFFF</code> This sequence will play a gesture every 8 beats (3x), play a gesture every 4 beats (4x), then play a gesture for 8 beats (1x), in that order. 
* <code>00F0FFFF</code> Play a gesture every 1/2 note (every 2 beats). 
* <code>0078FFFF</code> Play a gesture every 1/4 note (every beat). 
* <code>003CFFFF</code> Play a gesture every 1/8th note. 
* <code>001EFFFF</code> Play a gesture every 1/16th note. 
* <code>003C0078001EFFFF</code> This sequence will play a gesture for an 1/8th note, play a gesture for a 1/4 note, then play a gesture for a 1/16th note, in that order. 
Considering that <code>001E</code> (30 in decimal) is a 1/16th note, you can create any specific timing you want. Just add another 30 to the value for each additional sixteenth note in length. 
For example, Soil 1's enemy mix piano plays very rapidly; its timetable uses a value of 90, which looks like <code>005AFFFF</code>. The gestures last for three sixteenth notes. 
You can insert your timetables anywhere at the end of your BMS.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_3.png|Each timetable has a pink box around it.
</gallery>

== Filling in info ==
Once you have your gestures and timetables inserted, go back and fill in those <code>00AAAA</code>, <code>00BBBB</code>, <code>00CCCC</code> placeholders with the locations of your gesture sets, timetables, and gestures you want to use. Remember that gesture sets begin with the <code>00</code>.

Also in the very beginning of your BMS, make sure the value at <code>0x6</code> has the location of where your gesture set list begins (this one will probably be fine), and the value at <code>0x14</code> has the location of where your timing ruleset list begins.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_4.png|Put the location of where the "timing ruleset list" begins here.
</gallery>

== Filling in the conductor file ==
<gallery mode="packed-hover" widths=500px heights=500px>
File:CND_functions.png|Conductor file functions.
</gallery>
In your song's associated conductor file, try to stretch out the window so that the instrument names are all in the same column if you can, like in the image above. 
Each line represents one track. You give each track a instrument (program), and what gesture set and timing ruleset to use. 
The CND infographic above does a good job explaining all the functions, but they'll be explained again down here. 

In the top left corner are three important values:
* The first value is the swing time. <code>1E</code> is 1/16th swing, while <code>3C</code> is 1/8th swing. If your song is below 100bpm, you might want to use <code>1E</code>. If its faster, try <code>3C</code> instead.
* The second value is the tempo, in hex.
* The third value is how many tracks there will be, in hex.

Each column explained:
* A: Initial delay. How many beats until this track starts running. In the vanilla game, you can notice how some song's melodies do not immediately begin playing upon the start of level. This is useful for that; ease the listener into the music.
* B/Q: If set to 1, all gestures will be delayed by an 1/8th note..
* C: Text string. You can make this say whatever you like. Useful for keeping track of what you want each track to be, like "Lead", "Trumpet", "MelodyA"/"MelodyB", "Bass", or "Drums"
* D: Track copy. Select a previous track # to copy the gestures from. If the track its copying plays "gesture 3" from its gesture set, this track will also play its "gesture 3". Often used for treasure mix instruments. You can have them use different gesture sets if you like.
* E: Echo strength.
* F: If set to 1, the values in this track's timetable will always be played in order, in a loop. If set to 0, it will randomly select values from its timetable, thus, allowing you to randomize when gestures play.
* G: Bank number.
* H: Program number. For a list of all programs in the default game and the wScenes that support them, view [[Pikmin 2 custom_music/available instruments|this page]].
* I: Gesture set, select the set # you want to use from the BMS.
* J: Timing ruleset, select the set # you want to use from the BMS.
* K: How many gestures this track will play, before playing "silent gestures". Linked to below. These function as a sort of on/off cycle.
* L: How many "silent gestures" this track will play, before playing normal gestures. Linked to above. These function as a sort of on/off cycle.
* M: If notes are being transposed down (see below), this is set to FF. But this column doesn't actually do anything, so you don't need to edit this.
* N: Transpose all notes played by this track. To transpose up, use values 1-127. To transpose down, use the sign 2 compliment (values 128-255).
* O: Volume.
* P: Stereo panning.
 
Some ideas/considerations:
* You can use the on/off cycle feature (column K and L) to make your melodic instrument "take a break" every once in a while. You can have it play 4 gestures, but then be silent for 2.
* If your timing ruleset is strict (as in, the timings for when gestures occur is always consistent), something fun to try is to have the melody be a back-and-forth between two different instruments. Set the initial delay for the second instrument to be longer than the first one, and then cleverly use the on/off cycle to have the instruments take turns sounding a gesture. This is done for the melody in the Bulblax Kingdom and Frontier Cavern for example.
* If you are using the "track copy" feature (column D), you can have the primary instrument play a melody, and have this instrument always play chords that perfectly match that melody.

== Mapping the tracks ==
With all that done, don't forget to edit the song's [[Trackmap parameters|trackMap]]! Edit your song in the trackMap files in either <code>/user/Totaka</code> or <code>/user/Wakai</code>, and set how many instruments will be in each mix. It goes in order from: Main Mix, Task (event), Treasure (otakara), Enemy near (kehai), Combat mix, and Spiderwort mix (ground). Although you cannot find Spiderworts underground, you will have to sacrifice at least one track for that mix. You cannot set any of the mixes to have 0 instruments in them.

== Bonus: Filenames for brand new CND files ==
If you are adding a brand new CND file instead of replacing an existing one, the prefix will determine which BMS is loaded, and which wScene. Try not to add special characters to filenames, aside from underscores. 

In order to load the correct BMS file, the CND must start with the name of the BMS file.
* "caveconc.cnd", "caveconc_458435.cnd", "caveconc_Waffles.cnd", and "caveconc_Waffles_Song_2.cnd" will all load caveconc.bms. 
* "caverelax.cnd", "caverelax_Gmajor.cnd", and "caverelax_mamuta_dinner.cnd" will all load caverelax.bms. 
* "new_09_4.cnd", "new_09_4000.cnd", and "new_09_portal_PotaTOS.cnd" will load new_09.bms. 

For cavesoil, caveconc, and cavemetal only, the game also checks for an additional "_00", "_05", and "_10" right after the prefix, for the purpose of loading one of three different wScenes. You must include it if you want the correct wScene to load. For example, caveconc_05 loads wScene 31, so if you want your custom song to also load wScene 31, acceptable names include "caveconc_05_WAFFLES.cnd", "caveconc_05_52_46356.cnd", or "caveconc_05_super_boss.cnd". 

After adding your new CND file, be sure to add it to its respective trackMap file.

== Bonus: Adding new content to a vanilla BMS file ==
Adding new hex data in the middle of a file will shift all the offsets that come after it, causing your BMS to jump to the wrong locations, and likely cause a crash if vanilla songs are loaded. 
In order to add new content in addition to what's already in the BMS:
* Find and copy the gesture set list and the timing ruleset list, and paste them at the end of the file. (Separate them with lots of zeros so you have lots more space to add content to these lists)
* Change <code>0x6</code> and <code>0x14</code> to point to your new gesture set list and timing ruleset list. These two values tell the game where the lists are.
The game should now use these brand new lists, instead of the original instances that occur earlier in the file. Since they still contain all the locations of the vanilla gesture sets/timetables from above in the same order, the existing CND songs won't be affected and will continue to function, but now you can expand upon these lists with brand new entries now that you've made the space for them. All new gestures, gesture sets and timetables can be added further down the file.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Editing_vanilla_BMS_file.png|The new gesture set list and timing ruleset list we want to use will be at the bottom.
</gallery>

== Bonus: Adding gesture cutoffs in timetables ==
An intentional compositional choice in some songs is to cutoff gestures while they're in the middle of playing. The most common way this is done is to quickly trigger another gesture; if the last gesture has not finished playing, it will stop playing that gesture and begin playing the new one. It's also possible to add "empty" gestures to gesture sets (like <code>C40000015DFF</code>, a gesture which ends immediately and plays nothing), so you can randomly interrupt gestures in your song with silence, or have there be a chance to play nothing. 
However, if you wish to interrupt gestures in your song at specified times without the randomness, there is a special function in timetables for doing this. In the vanilla game, this is used for the trumpet in [https://www.youtube.com/watch?v=qOhmS1YLpF8 Fire]. The trumpet plays two interrupted gestures, then plays a third gesture in full. Below is the timetable for this trumpet: 
<code>0078 8168 81E0 00F0 80F0 81E0 0780 FFFF</code> 
The trumpet will:
* <code>0078</code> play a gesture for 1 beat
* <code>8168</code> cutoff after this 1 beat
* <code>81E0</code> extend the silence for another 4 beats
* <code>00F0</code> play a gesture for 2 beats
* <code>80F0</code> cutoff after these 2 beats
* <code>81E0</code> extend the silence for another 4 beats
* <code>0780</code> play a gesture for 16 beats. 
In order to put a "cutoff" in your timetable:
* Start with how long you want your "playing" gesture to play for, before it gets cutoff. I want the the first gesture to last for one beat (four 1/16th notes), so I'll put <code>0078</code>. Remember that every "30" in decimal is equivalent to a sixteenth note.
* Immediately next in the sequence will be a value that indicates when the cutoff begins. Calculate the difference between "81E0" and the previous value you had just inserted. 81E0 - 0078 = 8168 (in decimal, 33248 - 120 = 33128). I will put <code>8168</code> next in my sequence.
My sequence is now <code>0078 8168 FFFF</code>; this will play a gesture normally for 1 beat, but then immediately cut it off after that 1 beat. 
Putting an additional <code>81E0</code> in the sequence right after will the silence for another 4 beats. You can keep putting <code>81E0</code> right after several times in a row if you want depending on how long you want the silence to last, until the next gesture.

[[Category:Pikmin 2]]

Creating cave music

2024-04-16T13:35:51Z

Waffles: /* Gesture set contents */

Randomly generating cave music in Pikmin 2 needs to have two files: a .bms (sequence) file, and a .cnd (conductor) file.

The BMS file type is a sequenced music format used in many games. For the cave music in Pikmin 2 however, it is specially-formatted. It mainly contains many short snippets of musical information to be randomized.

The CND files are the actual "songs"; they take specific groups of snippets from a BMS file, and endlessly puzzle-piece them together to form a coherent piece of music.

This guide will function as a walkthrough for creating your own randomly sequencing cave song. All of the editing will be done in hexadecimal.

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be generating a lot of tiny BMS files, to turn them into "gestures".
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

== Overview of file functions ==
Here are some infographics that you can reference at any time. These show all the functions of a CND file, and all the contents of a BMS file.
<gallery mode="packed-hover" widths=250px heights=250px>
File:CND_functions.png|Conductor file functions.
File:BMS_functions.png|How information is stored in a BMS file.
</gallery>

== Setting up your BMS file ==
Before you begin, set your byte grouping to "3", so every 3 bytes is visually separated by a space. This will make it easier to see stuff. 
Starting with a completely blank BMS file, begin by pasting the following:
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600
</source>
Every cave music BMS begins with this same information, and will go mostly untouched.
 
 

== Gesture set list ==
Exactly right after <code>34C600</code> will be a list of every gesture set's location in the BMS. Each entry is the gesture set's hexadecimal location (offset), and each entry in the sequence begins with "<code>00</code>". <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0001B0 0001BF 0001CE 0001D4 0001DA 0001E9 0001F8 0001FE 000204 00020A FFFFFF</code> 
Gesture set "0" will be at offset <code>0x1B0</code>, gesture set "1" will be at offset <code>0x1BF</code>, gesture set "2" will be at <code>0x1CE</code>, and so on. There are a total of 10 gesture sets listed in the above sequence.
 
Until we create our gesture sets, let's use <code>00AAAA</code> as placeholders so we can easily find and get back to this section later on. You can have as many gesture sets as you like; we'll create 16 entries for this tutorial. You may insert this into your BMS: 
<code>00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF</code> 
 
Our BMS should now currently look like this: 
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000
</source>
You can also add an entire row of padding/zeros after this. You can do this for each section, to better visually separate them.
 

== Timing ruleset list ==
This is another sequence of offsets. These just point to the location of a "[[#Inserting_timetables|timetable]]", which will be located at the end of our BMS file. <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0005AB 0005AB 0005AF 0005C1 0005AB 0005AB 0005C1 0005C1 0005C1 0005C1 FFFFFF</code> 
Timing ruleset "0" will use the timetable at <code>0x5AB</code>, timing ruleset "1" will also use the timetable at <code>0x5AB</code>, timing ruleset "2" will use the timetable at <code>0x5AF</code>, and so on. There are a total of 10 timing rulesets listed in the above sequence.
 
Let's use <code>00BBBB</code> as placeholders again, and create 16 of them. Insert this anywhere into your BMS: 
<code>00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB FFFFFF</code> 
 

== Gesture set contents ==
A ''gesture set'' is a group of many gestures. 
Here, we list each gesture set's contents (which will be... the locations of the gestures!). Each gesture set begins before with <code>00</code> and ends with <code>FFFFFF</code>. 
Here is an example of how the gesture set list should be formatted: 
<code>000210 00022A 000258 000281 FFFFFF 0002B4 0002D9 000303 000331 FFFFFF 000355 FFFFFF 000361 FFFFFF 0003A8 0003C2 0003F0 000419 FFFFFF 00044C 000471 00049B 0004C9 FFFFFF 0004ED FFFFFF 000543 FFFFFF 000580 FFFFFF 00059E FFFFFF</code> 
There are 10 gesture sets listed above. The first gesture set has 4 gestures, located at <code>0x210</code>, <code>0x22A</code>, <code>0x258</code>, and <code>0x281</code>. You can have any amount of gestures in a gesture set; even 1 is fine.
 
You can paste the following placeholder information for now: 
<code>00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC FFFFFF</code> 
It might be a good idea to leave a decent amount of zeros after this list; this one will expand a lot as gestures and gesture sets are added to it.
 

== How is your BMS looking? ==
If you have been copy-pasting everything correctly, your BMS will look something like this:
<gallery mode="packed-hover" widths=300px heights=300px>
File:BMS_file_progress_1.png|Orange is "gesture set list", yellow is "timing ruleset list", and blue is "gesture set contents"
</gallery>
Once again, you can add as much padding between each section as you want, it will work fine.

== Creating gestures ==
First, you should sketch out your song idea in your DAW, and then cut your song into tiny blocks. These blocks will be your song's individual gestures. You should also consider dragging these blocks around in various arrangements to make sure they sound good in any order. 
Once you are ready, have them nicely organized and ready to be exported into individual MIDI files:
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_Pro_gestures.png|A Logic Pro project with a bunch of short blocks of music. Each block will be a "gesture".
</gallery>
For some reason, imported BMS files play 4 times as slow in cave songs. So if you import these gestures as is, they will play 4 times as slow. 
Before you export your gestures, you need to modify your gestures to run ''4 times as fast''. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each block.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>

== Inserting gestures ==
Gestures use same the note/music information as standard BMS songs. 

You should have converted all your MIDIs into BMS files. Open up one of your converted BMS files, and look for the first note/pitch value. If you used [[Pikmin 2 custom music|flaaffy]], this will most likely be somewhere after <code>0x1B</code>, <code>0x1C</code>, or <code>0x1D</code>. The note's pitch value will be followed by a <code>01</code>. Copy this note, all the way to the end of the sequence, which should be <code>FF</code>.
<gallery mode="packed-hover" widths=600px>
File:Copy_pasting_BMS_info.png|The value "2D" here is the hex value of a certain pitch, and the very first note of the sequence. Copy this, all the way to "FF".
</gallery>
To add your gesture, start it with <code>C40000015D</code>, then paste in what you copied. Each gesture should end with that <code>FF</code>. Add as many gestures as you please!
<gallery mode="packed-hover" widths=400px heights=400px>
File:BMS_file_progress_2.png|The purple lines indicate where a gesture starts.
</gallery>

== Inserting timetables ==
So, how do we choose how often gestures will play? Will a gesture play every beat? Every 1/2 a beat? You will need to add a timetable for that!
A timetable is a sequence that dictates when gestures should play. A timetable ends with <code>FFFF</code>. You can make a timetable as complex as you like. Some examples of timetables you can use are: 
* <code>0780FFFF</code> Play a gesture every 16 beats. 
* <code>03C0FFFF</code> Play a gesture every 8 beats. 
* <code>01E0FFFF</code> Play a gesture every 4 beats. 
* <code>03C003C003C001E001E001E001E003C0FFFF</code> This sequence will play a gesture every 8 beats (3x), play a gesture every 4 beats (4x), then play a gesture for 8 beats (1x), in that order. 
* <code>00F0FFFF</code> Play a gesture every 1/2 note (every 2 beats). 
* <code>0078FFFF</code> Play a gesture every 1/4 note (every beat). 
* <code>003CFFFF</code> Play a gesture every 1/8th note. 
* <code>001EFFFF</code> Play a gesture every 1/16th note. 
* <code>003C0078001EFFFF</code> This sequence will play a gesture for an 1/8th note, play a gesture for a 1/4 note, then play a gesture for a 1/16th note, in that order. 
Considering that <code>001E</code> (30 in decimal) is a 1/16th note, you can create any specific timing you want. Just add another 30 to the value for each additional sixteenth note in length. 
For example, Soil 1's enemy mix piano plays very rapidly; its timetable uses a value of 90, which looks like <code>005AFFFF</code>. The gestures last for three sixteenth notes. 
You can insert your timetables anywhere at the end of your BMS.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_3.png|Each timetable has a pink box around it.
</gallery>

== Filling in info ==
Once you have your gestures and timetables inserted, go back and fill in those <code>00AAAA</code>, <code>00BBBB</code>, <code>00CCCC</code> placeholders with the locations of your gesture sets, timetables, and gestures you want to use. Remember that gesture sets begin with the <code>00</code>.

Also in the very beginning of your BMS, make sure the value at <code>0x6</code> has the location of where your gesture set list begins (this one will probably be fine), and the value at <code>0x14</code> has the location of where your timing ruleset list begins.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_4.png|Put the location of where the "timing ruleset list" begins here.
</gallery>

== Filling in the conductor file ==
<gallery mode="packed-hover" widths=500px heights=500px>
File:CND_functions.png|Conductor file functions.
</gallery>
In your song's associated conductor file, try to stretch out the window so that the instrument names are all in the same column if you can, like in the image above. 
Each line represents one track. You give each track a instrument (program), and what gesture set and timing ruleset to use. 
The CND infographic above does a good job explaining all the functions, but they'll be explained again down here. 

In the top left corner are three important values:
* The first value is the swing time. <code>1E</code> is 1/16th swing, while <code>3C</code> is 1/8th swing. If your song is below 100bpm, you might want to use <code>1E</code>. If its faster, try <code>3C</code> instead.
* The second value is the tempo, in hex.
* The third value is how many tracks there will be, in hex.

Each column explained:
* A: Initial delay. How many beats until this track starts running. In the vanilla game, you can notice how some song's melodies do not immediately begin playing upon the start of level. This is useful for that; ease the listener into the music.
* B/Q: If set to 1, all gestures will be delayed by an 1/8th note..
* C: Text string. You can make this say whatever you like. Useful for keeping track of what you want each track to be, like "Lead", "Trumpet", "MelodyA"/"MelodyB", "Bass", or "Drums"
* D: Track copy. Select a previous track # to copy the gestures from. If the track its copying plays "gesture 3" from its gesture set, this track will also play its "gesture 3". Often used for treasure mix instruments. You can have them use different gesture sets if you like.
* E: Echo strength.
* F: If set to 1, the values in this track's timetable will always be played in order, in a loop. If set to 0, it will randomly select values from its timetable, thus, allowing you to randomize when gestures play.
* G: Bank number.
* H: Program number. For a list of all programs in the default game and the wScenes that support them, view [[Pikmin 2 custom_music/available instruments|this page]].
* I: Gesture set, select the set # you want to use from the BMS.
* J: Timing ruleset, select the set # you want to use from the BMS.
* K: How many gestures this track will play, before playing "silent gestures". Linked to below. These function as a sort of on/off cycle.
* L: How many "silent gestures" this track will play, before playing normal gestures. Linked to above. These function as a sort of on/off cycle.
* M: If notes are being transposed down (see below), this is set to FF. But this column doesn't actually do anything, so you don't need to edit this.
* N: Transpose all notes played by this track. To transpose up, use values 1-127. To transpose down, use the sign 2 compliment (values 128-255).
* O: Volume.
* P: Stereo panning.
 
Some ideas/considerations:
* You can use the on/off cycle feature (column K and L) to make your melodic instrument "take a break" every once in a while. You can have it play 4 gestures, but then be silent for 2.
* If your timing ruleset is strict (as in, the timings for when gestures occur is always consistent), something fun to try is to have the melody be a back-and-forth between two different instruments. Set the initial delay for the second instrument to be longer than the first one, and then cleverly use the on/off cycle to have the instruments take turns sounding a gesture. This is done for the melody in the Bulblax Kingdom and Frontier Cavern for example.
* If you are using the "track copy" feature (column D), you can have the primary instrument play a melody, and have this instrument always play chords that perfectly match that melody.

== Mapping the tracks ==
With all that done, don't forget to edit the song's [[Trackmap parameters|trackMap]]! Edit your song in the trackMap files in either <code>/user/Totaka</code> or <code>/user/Wakai</code>, and set how many instruments will be in each mix. It goes in order from: Main Mix, Task (event), Treasure (otakara), Enemy near (kehai), Combat mix, and Spiderwort mix (ground). Although you cannot find Spiderworts underground, you will have to sacrifice at least one track for that mix. You cannot set any of the mixes to have 0 instruments in them.

== Bonus: Filenames for brand new CND files ==
If you are adding a brand new CND file instead of replacing an existing one, the prefix will determine which BMS is loaded, and which wScene. Try not to add special characters to filenames, aside from underscores. 

In order to load the correct BMS file, the CND must start with the name of the BMS file.
* "caveconc.cnd", "caveconc_458435.cnd", "caveconc_Waffles.cnd", and "caveconc_Waffles_Song_2.cnd" will all load caveconc.bms. 
* "caverelax.cnd", "caverelax_Gmajor.cnd", and "caverelax_mamuta_dinner.cnd" will all load caverelax.bms. 
* "new_09_4.cnd", "new_09_4000.cnd", and "new_09_portal_PotaTOS.cnd" will load new_09.bms. 

For cavesoil, caveconc, and cavemetal only, the game also checks for an additional "_00", "_05", and "_10" right after the prefix, for the purpose of loading one of three different wScenes. You must include it if you want the correct wScene to load. For example, caveconc_05 loads wScene 31, so if you want your custom song to also load wScene 31, acceptable names include "caveconc_05_WAFFLES.cnd", "caveconc_05_52_46356.cnd", or "caveconc_05_super_boss.cnd". 

After adding your new CND file, be sure to add it to its respective trackMap file.

== Bonus: Adding new content to a vanilla BMS file ==
Adding new hex data in the middle of a file will shift all the offsets that come after it, causing your BMS to jump to the wrong locations, and likely cause a crash if vanilla songs are loaded. 
In order to add new content in addition to what's already in the BMS:
* Find and copy the gesture set list and the timing ruleset list, and paste them at the end of the file. (Separate them with lots of zeros so you have lots more space to add content to these lists)
* Change <code>0x6</code> and <code>0x14</code> to point to your new gesture set list and timing ruleset list. These two values tell the game where the lists are.
The game should now use these brand new lists, instead of the original instances that occur earlier in the file. Since they still contain all the locations of the vanilla gesture sets/timetables from above in the same order, the existing CND songs won't be affected and will continue to function, but now you can expand upon these lists with brand new entries now that you've made the space for them. All new gestures, gesture sets and timetables can be added further down the file.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Editing_vanilla_BMS_file.png|The new gesture set list and timing ruleset list we want to use will be at the bottom.
</gallery>

== Bonus: Adding gesture cutoffs in timetables ==
An intentional compositional choice in some songs is to cutoff gestures while they're in the middle of playing. The most common way this is done is to quickly trigger another gesture; if the last gesture has not finished playing, it will stop playing that gesture and begin playing the new one. It's also possible to add "empty" gestures to gesture sets (like <code>C40000015DFF</code>, a gesture which ends immediately and plays nothing), so you can randomly interrupt gestures in your song with silence, or have there be a chance to play nothing. 
However, if you wish to interrupt gestures in your song at specified times without the randomness, there is a special function in timetables for doing this. In the vanilla game, this is used for the trumpet in [https://www.youtube.com/watch?v=qOhmS1YLpF8 Fire]. The trumpet plays two interrupted gestures, then plays a third gesture in full. Below is the timetable for this trumpet: 
<code>0078 8168 81E0 00F0 80F0 81E0 0780 FFFF</code> 
The trumpet will:
* <code>0078</code> play a gesture for 1 beat
* <code>8168</code> cutoff after this 1 beat
* <code>81E0</code> extend the silence for another 4 beats
* <code>00F0</code> play a gesture for 2 beats
* <code>80F0</code> cutoff after these 2 beats
* <code>81E0</code> extend the silence for another 4 beats
* <code>0780</code> play a gesture for 16 beats. 
In order to put a "cutoff" in your timetable:
* Start with how long you want your "playing" gesture to play for, before it gets cutoff. I want the the first gesture to last for one beat (four 1/16th notes), so I'll put <code>0078</code>. Remember that every "30" in decimal is equivalent to a sixteenth note.
* Immediately next in the sequence will be a value that indicates when the cutoff begins. Calculate the difference between "81E0" and the previous value you had just inserted. 81E0 - 0078 = 8168 (in decimal, 33248 - 120 = 33128). I will put <code>8168</code> next in my sequence.
My sequence is now <code>0078 8168 FFFF</code>; this will play a gesture normally for 1 beat, but then immediately cut it off after that 1 beat. 
Putting an additional <code>81E0</code> in the sequence right after will the silence for another 4 beats. You can keep putting <code>81E0</code> right after several times in a row if you want depending on how long you want the silence to last, until the next gesture.

[[Category:Pikmin 2]]

Creating cave music

2024-04-16T13:30:17Z

Waffles: /* Setting up your BMS file */

Randomly generating cave music in Pikmin 2 needs to have two files: a .bms (sequence) file, and a .cnd (conductor) file.

The BMS file type is a sequenced music format used in many games. For the cave music in Pikmin 2 however, it is specially-formatted. It mainly contains many short snippets of musical information to be randomized.

The CND files are the actual "songs"; they take specific groups of snippets from a BMS file, and endlessly puzzle-piece them together to form a coherent piece of music.

This guide will function as a walkthrough for creating your own randomly sequencing cave song. All of the editing will be done in hexadecimal.

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be generating a lot of tiny BMS files, to turn them into "gestures".
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

== Overview of file functions ==
Here are some infographics that you can reference at any time. These show all the functions of a CND file, and all the contents of a BMS file.
<gallery mode="packed-hover" widths=250px heights=250px>
File:CND_functions.png|Conductor file functions.
File:BMS_functions.png|How information is stored in a BMS file.
</gallery>

== Setting up your BMS file ==
Before you begin, set your byte grouping to "3", so every 3 bytes is visually separated by a space. This will make it easier to see stuff. 
Starting with a completely blank BMS file, begin by pasting the following:
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600
</source>
Every cave music BMS begins with this same information, and will go mostly untouched.
 
 

== Gesture set list ==
Exactly right after <code>34C600</code> will be a list of every gesture set's location in the BMS. Each entry is the gesture set's hexadecimal location (offset), and each entry in the sequence begins with "<code>00</code>". <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0001B0 0001BF 0001CE 0001D4 0001DA 0001E9 0001F8 0001FE 000204 00020A FFFFFF</code> 
Gesture set "0" will be at offset <code>0x1B0</code>, gesture set "1" will be at offset <code>0x1BF</code>, gesture set "2" will be at <code>0x1CE</code>, and so on. There are a total of 10 gesture sets listed in the above sequence.
 
Until we create our gesture sets, let's use <code>00AAAA</code> as placeholders so we can easily find and get back to this section later on. You can have as many gesture sets as you like; we'll create 16 entries for this tutorial. You may insert this into your BMS: 
<code>00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF</code> 
 
Our BMS should now currently look like this: 
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000
</source>
You can also add an entire row of padding/zeros after this. You can do this for each section, to better visually separate them.
 

== Timing ruleset list ==
This is another sequence of offsets. These just point to the location of a "[[#Inserting_timetables|timetable]]", which will be located at the end of our BMS file. <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0005AB 0005AB 0005AF 0005C1 0005AB 0005AB 0005C1 0005C1 0005C1 0005C1 FFFFFF</code> 
Timing ruleset "0" will use the timetable at <code>0x5AB</code>, timing ruleset "1" will also use the timetable at <code>0x5AB</code>, timing ruleset "2" will use the timetable at <code>0x5AF</code>, and so on. There are a total of 10 timing rulesets listed in the above sequence.
 
Let's use <code>00BBBB</code> as placeholders again, and create 16 of them. Insert this anywhere into your BMS: 
<code>00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB FFFFFF</code> 
 

== Gesture set contents ==
A ''gesture set'' is a group of many gestures. 
Here, we list each gesture set's contents (which are... the locations of gestures!). Each gesture set begins before with <code>00</code> and ends with <code>FFFFFF</code>. 
Here is an example of how the gesture set list should be formatted: 
<code>000210 00022A 000258 000281 FFFFFF 0002B4 0002D9 000303 000331 FFFFFF 000355 FFFFFF 000361 FFFFFF 0003A8 0003C2 0003F0 000419 FFFFFF 00044C 000471 00049B 0004C9 FFFFFF 0004ED FFFFFF 000543 FFFFFF 000580 FFFFFF 00059E FFFFFF</code> 
There are 10 gesture sets listed above. The first gesture set has 4 gestures, located at <code>0x210</code>, <code>0x22A</code>, <code>0x258</code>, and <code>0x281</code>. You can have any amount of gestures in a gesture set; even 1 is fine.
 
You can paste the following placeholder information for now: 
<code>00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC FFFFFF</code> 
It might be a good idea to leave a decent amount of zeros after this list; this one will expand a lot as gestures and gesture sets are added to it.
 

== How is your BMS looking? ==
If you have been copy-pasting everything correctly, your BMS will look something like this:
<gallery mode="packed-hover" widths=300px heights=300px>
File:BMS_file_progress_1.png|Orange is "gesture set list", yellow is "timing ruleset list", and blue is "gesture set contents"
</gallery>
Once again, you can add as much padding between each section as you want, it will work fine.

== Creating gestures ==
First, you should sketch out your song idea in your DAW, and then cut your song into tiny blocks. These blocks will be your song's individual gestures. You should also consider dragging these blocks around in various arrangements to make sure they sound good in any order. 
Once you are ready, have them nicely organized and ready to be exported into individual MIDI files:
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_Pro_gestures.png|A Logic Pro project with a bunch of short blocks of music. Each block will be a "gesture".
</gallery>
For some reason, imported BMS files play 4 times as slow in cave songs. So if you import these gestures as is, they will play 4 times as slow. 
Before you export your gestures, you need to modify your gestures to run ''4 times as fast''. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each block.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>

== Inserting gestures ==
Gestures use same the note/music information as standard BMS songs. 

You should have converted all your MIDIs into BMS files. Open up one of your converted BMS files, and look for the first note/pitch value. If you used [[Pikmin 2 custom music|flaaffy]], this will most likely be somewhere after <code>0x1B</code>, <code>0x1C</code>, or <code>0x1D</code>. The note's pitch value will be followed by a <code>01</code>. Copy this note, all the way to the end of the sequence, which should be <code>FF</code>.
<gallery mode="packed-hover" widths=600px>
File:Copy_pasting_BMS_info.png|The value "2D" here is the hex value of a certain pitch, and the very first note of the sequence. Copy this, all the way to "FF".
</gallery>
To add your gesture, start it with <code>C40000015D</code>, then paste in what you copied. Each gesture should end with that <code>FF</code>. Add as many gestures as you please!
<gallery mode="packed-hover" widths=400px heights=400px>
File:BMS_file_progress_2.png|The purple lines indicate where a gesture starts.
</gallery>

== Inserting timetables ==
So, how do we choose how often gestures will play? Will a gesture play every beat? Every 1/2 a beat? You will need to add a timetable for that!
A timetable is a sequence that dictates when gestures should play. A timetable ends with <code>FFFF</code>. You can make a timetable as complex as you like. Some examples of timetables you can use are: 
* <code>0780FFFF</code> Play a gesture every 16 beats. 
* <code>03C0FFFF</code> Play a gesture every 8 beats. 
* <code>01E0FFFF</code> Play a gesture every 4 beats. 
* <code>03C003C003C001E001E001E001E003C0FFFF</code> This sequence will play a gesture every 8 beats (3x), play a gesture every 4 beats (4x), then play a gesture for 8 beats (1x), in that order. 
* <code>00F0FFFF</code> Play a gesture every 1/2 note (every 2 beats). 
* <code>0078FFFF</code> Play a gesture every 1/4 note (every beat). 
* <code>003CFFFF</code> Play a gesture every 1/8th note. 
* <code>001EFFFF</code> Play a gesture every 1/16th note. 
* <code>003C0078001EFFFF</code> This sequence will play a gesture for an 1/8th note, play a gesture for a 1/4 note, then play a gesture for a 1/16th note, in that order. 
Considering that <code>001E</code> (30 in decimal) is a 1/16th note, you can create any specific timing you want. Just add another 30 to the value for each additional sixteenth note in length. 
For example, Soil 1's enemy mix piano plays very rapidly; its timetable uses a value of 90, which looks like <code>005AFFFF</code>. The gestures last for three sixteenth notes. 
You can insert your timetables anywhere at the end of your BMS.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_3.png|Each timetable has a pink box around it.
</gallery>

== Filling in info ==
Once you have your gestures and timetables inserted, go back and fill in those <code>00AAAA</code>, <code>00BBBB</code>, <code>00CCCC</code> placeholders with the locations of your gesture sets, timetables, and gestures you want to use. Remember that gesture sets begin with the <code>00</code>.

Also in the very beginning of your BMS, make sure the value at <code>0x6</code> has the location of where your gesture set list begins (this one will probably be fine), and the value at <code>0x14</code> has the location of where your timing ruleset list begins.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_4.png|Put the location of where the "timing ruleset list" begins here.
</gallery>

== Filling in the conductor file ==
<gallery mode="packed-hover" widths=500px heights=500px>
File:CND_functions.png|Conductor file functions.
</gallery>
In your song's associated conductor file, try to stretch out the window so that the instrument names are all in the same column if you can, like in the image above. 
Each line represents one track. You give each track a instrument (program), and what gesture set and timing ruleset to use. 
The CND infographic above does a good job explaining all the functions, but they'll be explained again down here. 

In the top left corner are three important values:
* The first value is the swing time. <code>1E</code> is 1/16th swing, while <code>3C</code> is 1/8th swing. If your song is below 100bpm, you might want to use <code>1E</code>. If its faster, try <code>3C</code> instead.
* The second value is the tempo, in hex.
* The third value is how many tracks there will be, in hex.

Each column explained:
* A: Initial delay. How many beats until this track starts running. In the vanilla game, you can notice how some song's melodies do not immediately begin playing upon the start of level. This is useful for that; ease the listener into the music.
* B/Q: If set to 1, all gestures will be delayed by an 1/8th note..
* C: Text string. You can make this say whatever you like. Useful for keeping track of what you want each track to be, like "Lead", "Trumpet", "MelodyA"/"MelodyB", "Bass", or "Drums"
* D: Track copy. Select a previous track # to copy the gestures from. If the track its copying plays "gesture 3" from its gesture set, this track will also play its "gesture 3". Often used for treasure mix instruments. You can have them use different gesture sets if you like.
* E: Echo strength.
* F: If set to 1, the values in this track's timetable will always be played in order, in a loop. If set to 0, it will randomly select values from its timetable, thus, allowing you to randomize when gestures play.
* G: Bank number.
* H: Program number. For a list of all programs in the default game and the wScenes that support them, view [[Pikmin 2 custom_music/available instruments|this page]].
* I: Gesture set, select the set # you want to use from the BMS.
* J: Timing ruleset, select the set # you want to use from the BMS.
* K: How many gestures this track will play, before playing "silent gestures". Linked to below. These function as a sort of on/off cycle.
* L: How many "silent gestures" this track will play, before playing normal gestures. Linked to above. These function as a sort of on/off cycle.
* M: If notes are being transposed down (see below), this is set to FF. But this column doesn't actually do anything, so you don't need to edit this.
* N: Transpose all notes played by this track. To transpose up, use values 1-127. To transpose down, use the sign 2 compliment (values 128-255).
* O: Volume.
* P: Stereo panning.
 
Some ideas/considerations:
* You can use the on/off cycle feature (column K and L) to make your melodic instrument "take a break" every once in a while. You can have it play 4 gestures, but then be silent for 2.
* If your timing ruleset is strict (as in, the timings for when gestures occur is always consistent), something fun to try is to have the melody be a back-and-forth between two different instruments. Set the initial delay for the second instrument to be longer than the first one, and then cleverly use the on/off cycle to have the instruments take turns sounding a gesture. This is done for the melody in the Bulblax Kingdom and Frontier Cavern for example.
* If you are using the "track copy" feature (column D), you can have the primary instrument play a melody, and have this instrument always play chords that perfectly match that melody.

== Mapping the tracks ==
With all that done, don't forget to edit the song's [[Trackmap parameters|trackMap]]! Edit your song in the trackMap files in either <code>/user/Totaka</code> or <code>/user/Wakai</code>, and set how many instruments will be in each mix. It goes in order from: Main Mix, Task (event), Treasure (otakara), Enemy near (kehai), Combat mix, and Spiderwort mix (ground). Although you cannot find Spiderworts underground, you will have to sacrifice at least one track for that mix. You cannot set any of the mixes to have 0 instruments in them.

== Bonus: Filenames for brand new CND files ==
If you are adding a brand new CND file instead of replacing an existing one, the prefix will determine which BMS is loaded, and which wScene. Try not to add special characters to filenames, aside from underscores. 

In order to load the correct BMS file, the CND must start with the name of the BMS file.
* "caveconc.cnd", "caveconc_458435.cnd", "caveconc_Waffles.cnd", and "caveconc_Waffles_Song_2.cnd" will all load caveconc.bms. 
* "caverelax.cnd", "caverelax_Gmajor.cnd", and "caverelax_mamuta_dinner.cnd" will all load caverelax.bms. 
* "new_09_4.cnd", "new_09_4000.cnd", and "new_09_portal_PotaTOS.cnd" will load new_09.bms. 

For cavesoil, caveconc, and cavemetal only, the game also checks for an additional "_00", "_05", and "_10" right after the prefix, for the purpose of loading one of three different wScenes. You must include it if you want the correct wScene to load. For example, caveconc_05 loads wScene 31, so if you want your custom song to also load wScene 31, acceptable names include "caveconc_05_WAFFLES.cnd", "caveconc_05_52_46356.cnd", or "caveconc_05_super_boss.cnd". 

After adding your new CND file, be sure to add it to its respective trackMap file.

== Bonus: Adding new content to a vanilla BMS file ==
Adding new hex data in the middle of a file will shift all the offsets that come after it, causing your BMS to jump to the wrong locations, and likely cause a crash if vanilla songs are loaded. 
In order to add new content in addition to what's already in the BMS:
* Find and copy the gesture set list and the timing ruleset list, and paste them at the end of the file. (Separate them with lots of zeros so you have lots more space to add content to these lists)
* Change <code>0x6</code> and <code>0x14</code> to point to your new gesture set list and timing ruleset list. These two values tell the game where the lists are.
The game should now use these brand new lists, instead of the original instances that occur earlier in the file. Since they still contain all the locations of the vanilla gesture sets/timetables from above in the same order, the existing CND songs won't be affected and will continue to function, but now you can expand upon these lists with brand new entries now that you've made the space for them. All new gestures, gesture sets and timetables can be added further down the file.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Editing_vanilla_BMS_file.png|The new gesture set list and timing ruleset list we want to use will be at the bottom.
</gallery>

== Bonus: Adding gesture cutoffs in timetables ==
An intentional compositional choice in some songs is to cutoff gestures while they're in the middle of playing. The most common way this is done is to quickly trigger another gesture; if the last gesture has not finished playing, it will stop playing that gesture and begin playing the new one. It's also possible to add "empty" gestures to gesture sets (like <code>C40000015DFF</code>, a gesture which ends immediately and plays nothing), so you can randomly interrupt gestures in your song with silence, or have there be a chance to play nothing. 
However, if you wish to interrupt gestures in your song at specified times without the randomness, there is a special function in timetables for doing this. In the vanilla game, this is used for the trumpet in [https://www.youtube.com/watch?v=qOhmS1YLpF8 Fire]. The trumpet plays two interrupted gestures, then plays a third gesture in full. Below is the timetable for this trumpet: 
<code>0078 8168 81E0 00F0 80F0 81E0 0780 FFFF</code> 
The trumpet will:
* <code>0078</code> play a gesture for 1 beat
* <code>8168</code> cutoff after this 1 beat
* <code>81E0</code> extend the silence for another 4 beats
* <code>00F0</code> play a gesture for 2 beats
* <code>80F0</code> cutoff after these 2 beats
* <code>81E0</code> extend the silence for another 4 beats
* <code>0780</code> play a gesture for 16 beats. 
In order to put a "cutoff" in your timetable:
* Start with how long you want your "playing" gesture to play for, before it gets cutoff. I want the the first gesture to last for one beat (four 1/16th notes), so I'll put <code>0078</code>. Remember that every "30" in decimal is equivalent to a sixteenth note.
* Immediately next in the sequence will be a value that indicates when the cutoff begins. Calculate the difference between "81E0" and the previous value you had just inserted. 81E0 - 0078 = 8168 (in decimal, 33248 - 120 = 33128). I will put <code>8168</code> next in my sequence.
My sequence is now <code>0078 8168 FFFF</code>; this will play a gesture normally for 1 beat, but then immediately cut it off after that 1 beat. 
Putting an additional <code>81E0</code> in the sequence right after will the silence for another 4 beats. You can keep putting <code>81E0</code> right after several times in a row if you want depending on how long you want the silence to last, until the next gesture.

[[Category:Pikmin 2]]

Trackmap parameters

2024-04-09T23:07:53Z

Waffles: More info

In ''Pikmin 2'', the trackMap files located in <code>/user/Totaka</code> and <code>/user/Wakai</code> respectively are responsible for mapping instruments into certain mixes. They also set which instruments will skip notes when a Pikmin has died and the player has less than 10 Pikmin. There can be a maximum of 32 entries in each trackMap file; the game will fail to read a 33rd entry.

Format:
<source lang="powershell">
cavesong_XX_Y.cnd
{
4 # basic (Main mix)
2 # event (Task mix)
2 # otakara event (Treasure mix)
1 # kehai (Enemy mix)
2 # battle (Combat mix)
2 # ground (Spiderwort mix)

# pikmin数演出トラック定義
{
1 1 1 1 # 0~3
0 0 0 0 # 4~7
0 0 0 0 # 8~11
0 0 0 0 # 12~15
}

# マスクするnote on ID
{
0 0 0 1 #0~3
1 1 1 1 #4~7
}
}
</source>
* The first part is how many instruments will be in each mix. They must be grouped sequentially; in this example, the first 4 instruments in the song will be in the main mix, the next 2 instruments will be in the task mix, and so on. ''Each mix must contain at least 1 track, as a mix with 0 tracks will not work. Additionally, the sum of all the tracks must not be greater than 16, which is the maximum number of tracks a song can have.''
* The 16 values below is which of the 16 tracks will skip notes. Tracks set to "1" will skip notes when a Pikmin has died and the Pikmin count is below 10. ''There must be at least one track set to 1, or the game will crash.''
* The 8 values at the bottom is a table for when notes will be skipped in the theme. This was left the same for every song in the vanilla game. ''Setting all 8 values to 0 will make it so there is no difference when the player loses a lot of Pikmin; if they are all set to 1, the instrument will practically disappear completely.''

[[Category:Pikmin 2]]

Creating cave music

2024-04-03T23:01:22Z

Waffles: /* Bonus: Adding gesture cutoffs in timetables */

Randomly generating cave music in Pikmin 2 needs to have two files: a .bms (sequence) file, and a .cnd (conductor) file.

The BMS file type is a sequenced music format used in many games. For the cave music in Pikmin 2 however, it is specially-formatted. It mainly contains many short snippets of musical information to be randomized.

The CND files are the actual "songs"; they take specific groups of snippets from a BMS file, and endlessly puzzle-piece them together to form a coherent piece of music.

This guide will function as a walkthrough for creating your own randomly sequencing cave song. All of the editing will be done in hexadecimal.

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be generating a lot of tiny BMS files, to turn them into "gestures".
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

== Overview of file functions ==
Here are some infographics that you can reference at any time. These show all the functions of a CND file, and all the contents of a BMS file.
<gallery mode="packed-hover" widths=250px heights=250px>
File:CND_functions.png|Conductor file functions.
File:BMS_functions.png|How information is stored in a BMS file.
</gallery>

== Setting up your BMS file ==
Before you begin, set your byte grouping to "3", so every 3 bytes is visually separated by a space. This will make it easier to see stuff. 
Starting with a completely blank BMS file, begin by pasting the following:
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600
</source>
Every cave music BMS begins with this same information.
 
 
== Gesture set list ==
Exactly right after <code>34C600</code> will be a list of every gesture set's location in the BMS. Each entry is the gesture set's hexadecimal location (offset), and each entry in the sequence begins with "<code>00</code>". <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0001B0 0001BF 0001CE 0001D4 0001DA 0001E9 0001F8 0001FE 000204 00020A FFFFFF</code> 
Gesture set "0" will be at offset <code>0x1B0</code>, gesture set "1" will be at offset <code>0x1BF</code>, gesture set "2" will be at <code>0x1CE</code>, and so on. There are a total of 10 gesture sets listed in the above sequence.
 
Until we create our gesture sets, let's use <code>00AAAA</code> as placeholders so we can easily find and get back to this section later on. You can have as many gesture sets as you like; we'll create 16 entries for this tutorial. You may insert this into your BMS: 
<code>00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF</code> 
 
Our BMS should now currently look like this: 
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000
</source>
You can also add an entire row of padding/zeros after this. You can do this for each section, to better visually separate them.
 

== Timing ruleset list ==
This is another sequence of offsets. These just point to the location of a "[[#Inserting_timetables|timetable]]", which will be located at the end of our BMS file. <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0005AB 0005AB 0005AF 0005C1 0005AB 0005AB 0005C1 0005C1 0005C1 0005C1 FFFFFF</code> 
Timing ruleset "0" will use the timetable at <code>0x5AB</code>, timing ruleset "1" will also use the timetable at <code>0x5AB</code>, timing ruleset "2" will use the timetable at <code>0x5AF</code>, and so on. There are a total of 10 timing rulesets listed in the above sequence.
 
Let's use <code>00BBBB</code> as placeholders again, and create 16 of them. Insert this anywhere into your BMS: 
<code>00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB FFFFFF</code> 
 

== Gesture set contents ==
A ''gesture set'' is a group of many gestures. 
Here, we list each gesture set's contents (which are... the locations of gestures!). Each gesture set begins before with <code>00</code> and ends with <code>FFFFFF</code>. 
Here is an example of how the gesture set list should be formatted: 
<code>000210 00022A 000258 000281 FFFFFF 0002B4 0002D9 000303 000331 FFFFFF 000355 FFFFFF 000361 FFFFFF 0003A8 0003C2 0003F0 000419 FFFFFF 00044C 000471 00049B 0004C9 FFFFFF 0004ED FFFFFF 000543 FFFFFF 000580 FFFFFF 00059E FFFFFF</code> 
There are 10 gesture sets listed above. The first gesture set has 4 gestures, located at <code>0x210</code>, <code>0x22A</code>, <code>0x258</code>, and <code>0x281</code>. You can have any amount of gestures in a gesture set; even 1 is fine.
 
You can paste the following placeholder information for now: 
<code>00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC FFFFFF</code> 
It might be a good idea to leave a decent amount of zeros after this list; this one will expand a lot as gestures and gesture sets are added to it.
 

== How is your BMS looking? ==
If you have been copy-pasting everything correctly, your BMS will look something like this:
<gallery mode="packed-hover" widths=300px heights=300px>
File:BMS_file_progress_1.png|Orange is "gesture set list", yellow is "timing ruleset list", and blue is "gesture set contents"
</gallery>
Once again, you can add as much padding between each section as you want, it will work fine.

== Creating gestures ==
First, you should sketch out your song idea in your DAW, and then cut your song into tiny blocks. These blocks will be your song's individual gestures. You should also consider dragging these blocks around in various arrangements to make sure they sound good in any order. 
Once you are ready, have them nicely organized and ready to be exported into individual MIDI files:
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_Pro_gestures.png|A Logic Pro project with a bunch of short blocks of music. Each block will be a "gesture".
</gallery>
For some reason, imported BMS files play 4 times as slow in cave songs. So if you import these gestures as is, they will play 4 times as slow. 
Before you export your gestures, you need to modify your gestures to run ''4 times as fast''. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each block.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>

== Inserting gestures ==
Gestures use same the note/music information as standard BMS songs. 

You should have converted all your MIDIs into BMS files. Open up one of your converted BMS files, and look for the first note/pitch value. If you used [[Pikmin 2 custom music|flaaffy]], this will most likely be somewhere after <code>0x1B</code>, <code>0x1C</code>, or <code>0x1D</code>. The note's pitch value will be followed by a <code>01</code>. Copy this note, all the way to the end of the sequence, which should be <code>FF</code>.
<gallery mode="packed-hover" widths=600px>
File:Copy_pasting_BMS_info.png|The value "2D" here is the hex value of a certain pitch, and the very first note of the sequence. Copy this, all the way to "FF".
</gallery>
To add your gesture, start it with <code>C40000015D</code>, then paste in what you copied. Each gesture should end with that <code>FF</code>. Add as many gestures as you please!
<gallery mode="packed-hover" widths=400px heights=400px>
File:BMS_file_progress_2.png|The purple lines indicate where a gesture starts.
</gallery>

== Inserting timetables ==
So, how do we choose how often gestures will play? Will a gesture play every beat? Every 1/2 a beat? You will need to add a timetable for that!
A timetable is a sequence that dictates when gestures should play. A timetable ends with <code>FFFF</code>. You can make a timetable as complex as you like. Some examples of timetables you can use are: 
* <code>0780FFFF</code> Play a gesture every 16 beats. 
* <code>03C0FFFF</code> Play a gesture every 8 beats. 
* <code>01E0FFFF</code> Play a gesture every 4 beats. 
* <code>03C003C003C001E001E001E001E003C0FFFF</code> This sequence will play a gesture every 8 beats (3x), play a gesture every 4 beats (4x), then play a gesture for 8 beats (1x), in that order. 
* <code>00F0FFFF</code> Play a gesture every 1/2 note (every 2 beats). 
* <code>0078FFFF</code> Play a gesture every 1/4 note (every beat). 
* <code>003CFFFF</code> Play a gesture every 1/8th note. 
* <code>001EFFFF</code> Play a gesture every 1/16th note. 
* <code>003C0078001EFFFF</code> This sequence will play a gesture for an 1/8th note, play a gesture for a 1/4 note, then play a gesture for a 1/16th note, in that order. 
Considering that <code>001E</code> (30 in decimal) is a 1/16th note, you can create any specific timing you want. Just add another 30 to the value for each additional sixteenth note in length. 
For example, Soil 1's enemy mix piano plays very rapidly; its timetable uses a value of 90, which looks like <code>005AFFFF</code>. The gestures last for three sixteenth notes. 
You can insert your timetables anywhere at the end of your BMS.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_3.png|Each timetable has a pink box around it.
</gallery>

== Filling in info ==
Once you have your gestures and timetables inserted, go back and fill in those <code>00AAAA</code>, <code>00BBBB</code>, <code>00CCCC</code> placeholders with the locations of your gesture sets, timetables, and gestures you want to use. Remember that gesture sets begin with the <code>00</code>.

Also in the very beginning of your BMS, make sure the value at <code>0x6</code> has the location of where your gesture set list begins (this one will probably be fine), and the value at <code>0x14</code> has the location of where your timing ruleset list begins.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_4.png|Put the location of where the "timing ruleset list" begins here.
</gallery>

== Filling in the conductor file ==
<gallery mode="packed-hover" widths=500px heights=500px>
File:CND_functions.png|Conductor file functions.
</gallery>
In your song's associated conductor file, try to stretch out the window so that the instrument names are all in the same column if you can, like in the image above. 
Each line represents one track. You give each track a instrument (program), and what gesture set and timing ruleset to use. 
The CND infographic above does a good job explaining all the functions, but they'll be explained again down here. 

In the top left corner are three important values:
* The first value is the swing time. <code>1E</code> is 1/16th swing, while <code>3C</code> is 1/8th swing. If your song is below 100bpm, you might want to use <code>1E</code>. If its faster, try <code>3C</code> instead.
* The second value is the tempo, in hex.
* The third value is how many tracks there will be, in hex.

Each column explained:
* A: Initial delay. How many beats until this track starts running. In the vanilla game, you can notice how some song's melodies do not immediately begin playing upon the start of level. This is useful for that; ease the listener into the music.
* B/Q: If set to 1, all gestures will be delayed by an 1/8th note..
* C: Text string. You can make this say whatever you like. Useful for keeping track of what you want each track to be, like "Lead", "Trumpet", "MelodyA"/"MelodyB", "Bass", or "Drums"
* D: Track copy. Select a previous track # to copy the gestures from. If the track its copying plays "gesture 3" from its gesture set, this track will also play its "gesture 3". Often used for treasure mix instruments. You can have them use different gesture sets if you like.
* E: Echo strength.
* F: If set to 1, the values in this track's timetable will always be played in order, in a loop. If set to 0, it will randomly select values from its timetable, thus, allowing you to randomize when gestures play.
* G: Bank number.
* H: Program number. For a list of all programs in the default game and the wScenes that support them, view [[Pikmin 2 custom_music/available instruments|this page]].
* I: Gesture set, select the set # you want to use from the BMS.
* J: Timing ruleset, select the set # you want to use from the BMS.
* K: How many gestures this track will play, before playing "silent gestures". Linked to below. These function as a sort of on/off cycle.
* L: How many "silent gestures" this track will play, before playing normal gestures. Linked to above. These function as a sort of on/off cycle.
* M: If notes are being transposed down (see below), this is set to FF. But this column doesn't actually do anything, so you don't need to edit this.
* N: Transpose all notes played by this track. To transpose up, use values 1-127. To transpose down, use the sign 2 compliment (values 128-255).
* O: Volume.
* P: Stereo panning.
 
Some ideas/considerations:
* You can use the on/off cycle feature (column K and L) to make your melodic instrument "take a break" every once in a while. You can have it play 4 gestures, but then be silent for 2.
* If your timing ruleset is strict (as in, the timings for when gestures occur is always consistent), something fun to try is to have the melody be a back-and-forth between two different instruments. Set the initial delay for the second instrument to be longer than the first one, and then cleverly use the on/off cycle to have the instruments take turns sounding a gesture. This is done for the melody in the Bulblax Kingdom and Frontier Cavern for example.
* If you are using the "track copy" feature (column D), you can have the primary instrument play a melody, and have this instrument always play chords that perfectly match that melody.

== Mapping the tracks ==
With all that done, don't forget to edit the song's [[Trackmap parameters|trackMap]]! Edit your song in the trackMap files in either <code>/user/Totaka</code> or <code>/user/Wakai</code>, and set how many instruments will be in each mix. It goes in order from: Main Mix, Task (event), Treasure (otakara), Enemy near (kehai), Combat mix, and Spiderwort mix (ground). Although you cannot find Spiderworts underground, you will have to sacrifice at least one track for that mix. You cannot set any of the mixes to have 0 instruments in them.

== Bonus: Filenames for brand new CND files ==
If you are adding a brand new CND file instead of replacing an existing one, the prefix will determine which BMS is loaded, and which wScene. Try not to add special characters to filenames, aside from underscores. 

In order to load the correct BMS file, the CND must start with the name of the BMS file.
* "caveconc.cnd", "caveconc_458435.cnd", "caveconc_Waffles.cnd", and "caveconc_Waffles_Song_2.cnd" will all load caveconc.bms. 
* "caverelax.cnd", "caverelax_Gmajor.cnd", and "caverelax_mamuta_dinner.cnd" will all load caverelax.bms. 
* "new_09_4.cnd", "new_09_4000.cnd", and "new_09_portal_PotaTOS.cnd" will load new_09.bms. 

For cavesoil, caveconc, and cavemetal only, the game also checks for an additional "_00", "_05", and "_10" right after the prefix, for the purpose of loading one of three different wScenes. You must include it if you want the correct wScene to load. For example, caveconc_05 loads wScene 31, so if you want your custom song to also load wScene 31, acceptable names include "caveconc_05_WAFFLES.cnd", "caveconc_05_52_46356.cnd", or "caveconc_05_super_boss.cnd". 

After adding your new CND file, be sure to add it to its respective trackMap file.

== Bonus: Adding new content to a vanilla BMS file ==
Adding new hex data in the middle of a file will shift all the offsets that come after it, causing your BMS to jump to the wrong locations, and likely cause a crash if vanilla songs are loaded. 
In order to add new content in addition to what's already in the BMS:
* Find and copy the gesture set list and the timing ruleset list, and paste them at the end of the file. (Separate them with lots of zeros so you have lots more space to add content to these lists)
* Change <code>0x6</code> and <code>0x14</code> to point to your new gesture set list and timing ruleset list. These two values tell the game where the lists are.
The game should now use these brand new lists, instead of the original instances that occur earlier in the file. Since they still contain all the locations of the vanilla gesture sets/timetables from above in the same order, the existing CND songs won't be affected and will continue to function, but now you can expand upon these lists with brand new entries now that you've made the space for them. All new gestures, gesture sets and timetables can be added further down the file.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Editing_vanilla_BMS_file.png|The new gesture set list and timing ruleset list we want to use will be at the bottom.
</gallery>

== Bonus: Adding gesture cutoffs in timetables ==
An intentional compositional choice in some songs is to cutoff gestures while they're in the middle of playing. The most common way this is done is to quickly trigger another gesture; if the last gesture has not finished playing, it will stop playing that gesture and begin playing the new one. It's also possible to add "empty" gestures to gesture sets (like <code>C40000015DFF</code>, a gesture which ends immediately and plays nothing), so you can randomly interrupt gestures in your song with silence, or have there be a chance to play nothing. 
However, if you wish to interrupt gestures in your song at specified times without the randomness, there is a special function in timetables for doing this. In the vanilla game, this is used for the trumpet in [https://www.youtube.com/watch?v=qOhmS1YLpF8 Fire]. The trumpet plays two interrupted gestures, then plays a third gesture in full. Below is the timetable for this trumpet: 
<code>0078 8168 81E0 00F0 80F0 81E0 0780 FFFF</code> 
The trumpet will:
* <code>0078</code> play a gesture for 1 beat
* <code>8168</code> cutoff after this 1 beat
* <code>81E0</code> extend the silence for another 4 beats
* <code>00F0</code> play a gesture for 2 beats
* <code>80F0</code> cutoff after these 2 beats
* <code>81E0</code> extend the silence for another 4 beats
* <code>0780</code> play a gesture for 16 beats. 
In order to put a "cutoff" in your timetable:
* Start with how long you want your "playing" gesture to play for, before it gets cutoff. I want the the first gesture to last for one beat (four 1/16th notes), so I'll put <code>0078</code>. Remember that every "30" in decimal is equivalent to a sixteenth note.
* Immediately next in the sequence will be a value that indicates when the cutoff begins. Calculate the difference between "81E0" and the previous value you had just inserted. 81E0 - 0078 = 8168 (in decimal, 33248 - 120 = 33128). I will put <code>8168</code> next in my sequence.
My sequence is now <code>0078 8168 FFFF</code>; this will play a gesture normally for 1 beat, but then immediately cut it off after that 1 beat. 
Putting an additional <code>81E0</code> in the sequence right after will the silence for another 4 beats. You can keep putting <code>81E0</code> right after several times in a row if you want depending on how long you want the silence to last, until the next gesture.

[[Category:Pikmin 2]]

Creating cave music

2024-03-26T15:45:44Z

Waffles: /* Bonus: Adding gesture cutoffs in timetables */

Randomly generating cave music in Pikmin 2 needs to have two files: a .bms (sequence) file, and a .cnd (conductor) file.

The BMS file type is a sequenced music format used in many games. For the cave music in Pikmin 2 however, it is specially-formatted. It mainly contains many short snippets of musical information to be randomized.

The CND files are the actual "songs"; they take specific groups of snippets from a BMS file, and endlessly puzzle-piece them together to form a coherent piece of music.

This guide will function as a walkthrough for creating your own randomly sequencing cave song. All of the editing will be done in hexadecimal.

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be generating a lot of tiny BMS files, to turn them into "gestures".
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

== Overview of file functions ==
Here are some infographics that you can reference at any time. These show all the functions of a CND file, and all the contents of a BMS file.
<gallery mode="packed-hover" widths=250px heights=250px>
File:CND_functions.png|Conductor file functions.
File:BMS_functions.png|How information is stored in a BMS file.
</gallery>

== Setting up your BMS file ==
Before you begin, set your byte grouping to "3", so every 3 bytes is visually separated by a space. This will make it easier to see stuff. 
Starting with a completely blank BMS file, begin by pasting the following:
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600
</source>
Every cave music BMS begins with this same information.
 
 
== Gesture set list ==
Exactly right after <code>34C600</code> will be a list of every gesture set's location in the BMS. Each entry is the gesture set's hexadecimal location (offset), and each entry in the sequence begins with "<code>00</code>". <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0001B0 0001BF 0001CE 0001D4 0001DA 0001E9 0001F8 0001FE 000204 00020A FFFFFF</code> 
Gesture set "0" will be at offset <code>0x1B0</code>, gesture set "1" will be at offset <code>0x1BF</code>, gesture set "2" will be at <code>0x1CE</code>, and so on. There are a total of 10 gesture sets listed in the above sequence.
 
Until we create our gesture sets, let's use <code>00AAAA</code> as placeholders so we can easily find and get back to this section later on. You can have as many gesture sets as you like; we'll create 16 entries for this tutorial. You may insert this into your BMS: 
<code>00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF</code> 
 
Our BMS should now currently look like this: 
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000
</source>
You can also add an entire row of padding/zeros after this. You can do this for each section, to better visually separate them.
 

== Timing ruleset list ==
This is another sequence of offsets. These just point to the location of a "[[#Inserting_timetables|timetable]]", which will be located at the end of our BMS file. <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0005AB 0005AB 0005AF 0005C1 0005AB 0005AB 0005C1 0005C1 0005C1 0005C1 FFFFFF</code> 
Timing ruleset "0" will use the timetable at <code>0x5AB</code>, timing ruleset "1" will also use the timetable at <code>0x5AB</code>, timing ruleset "2" will use the timetable at <code>0x5AF</code>, and so on. There are a total of 10 timing rulesets listed in the above sequence.
 
Let's use <code>00BBBB</code> as placeholders again, and create 16 of them. Insert this anywhere into your BMS: 
<code>00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB FFFFFF</code> 
 

== Gesture set contents ==
A ''gesture set'' is a group of many gestures. 
Here, we list each gesture set's contents (which are... the locations of gestures!). Each gesture set begins before with <code>00</code> and ends with <code>FFFFFF</code>. 
Here is an example of how the gesture set list should be formatted: 
<code>000210 00022A 000258 000281 FFFFFF 0002B4 0002D9 000303 000331 FFFFFF 000355 FFFFFF 000361 FFFFFF 0003A8 0003C2 0003F0 000419 FFFFFF 00044C 000471 00049B 0004C9 FFFFFF 0004ED FFFFFF 000543 FFFFFF 000580 FFFFFF 00059E FFFFFF</code> 
There are 10 gesture sets listed above. The first gesture set has 4 gestures, located at <code>0x210</code>, <code>0x22A</code>, <code>0x258</code>, and <code>0x281</code>. You can have any amount of gestures in a gesture set; even 1 is fine.
 
You can paste the following placeholder information for now: 
<code>00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC FFFFFF</code> 
It might be a good idea to leave a decent amount of zeros after this list; this one will expand a lot as gestures and gesture sets are added to it.
 

== How is your BMS looking? ==
If you have been copy-pasting everything correctly, your BMS will look something like this:
<gallery mode="packed-hover" widths=300px heights=300px>
File:BMS_file_progress_1.png|Orange is "gesture set list", yellow is "timing ruleset list", and blue is "gesture set contents"
</gallery>
Once again, you can add as much padding between each section as you want, it will work fine.

== Creating gestures ==
First, you should sketch out your song idea in your DAW, and then cut your song into tiny blocks. These blocks will be your song's individual gestures. You should also consider dragging these blocks around in various arrangements to make sure they sound good in any order. 
Once you are ready, have them nicely organized and ready to be exported into individual MIDI files:
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_Pro_gestures.png|A Logic Pro project with a bunch of short blocks of music. Each block will be a "gesture".
</gallery>
For some reason, imported BMS files play 4 times as slow in cave songs. So if you import these gestures as is, they will play 4 times as slow. 
Before you export your gestures, you need to modify your gestures to run ''4 times as fast''. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each block.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>

== Inserting gestures ==
Gestures use same the note/music information as standard BMS songs. 

You should have converted all your MIDIs into BMS files. Open up one of your converted BMS files, and look for the first note/pitch value. If you used [[Pikmin 2 custom music|flaaffy]], this will most likely be somewhere after <code>0x1B</code>, <code>0x1C</code>, or <code>0x1D</code>. The note's pitch value will be followed by a <code>01</code>. Copy this note, all the way to the end of the sequence, which should be <code>FF</code>.
<gallery mode="packed-hover" widths=600px>
File:Copy_pasting_BMS_info.png|The value "2D" here is the hex value of a certain pitch, and the very first note of the sequence. Copy this, all the way to "FF".
</gallery>
To add your gesture, start it with <code>C40000015D</code>, then paste in what you copied. Each gesture should end with that <code>FF</code>. Add as many gestures as you please!
<gallery mode="packed-hover" widths=400px heights=400px>
File:BMS_file_progress_2.png|The purple lines indicate where a gesture starts.
</gallery>

== Inserting timetables ==
So, how do we choose how often gestures will play? Will a gesture play every beat? Every 1/2 a beat? You will need to add a timetable for that!
A timetable is a sequence that dictates when gestures should play. A timetable ends with <code>FFFF</code>. You can make a timetable as complex as you like. Some examples of timetables you can use are: 
* <code>0780FFFF</code> Play a gesture every 16 beats. 
* <code>03C0FFFF</code> Play a gesture every 8 beats. 
* <code>01E0FFFF</code> Play a gesture every 4 beats. 
* <code>03C003C003C001E001E001E001E003C0FFFF</code> This sequence will play a gesture every 8 beats (3x), play a gesture every 4 beats (4x), then play a gesture for 8 beats (1x), in that order. 
* <code>00F0FFFF</code> Play a gesture every 1/2 note (every 2 beats). 
* <code>0078FFFF</code> Play a gesture every 1/4 note (every beat). 
* <code>003CFFFF</code> Play a gesture every 1/8th note. 
* <code>001EFFFF</code> Play a gesture every 1/16th note. 
* <code>003C0078001EFFFF</code> This sequence will play a gesture for an 1/8th note, play a gesture for a 1/4 note, then play a gesture for a 1/16th note, in that order. 
Considering that <code>001E</code> (30 in decimal) is a 1/16th note, you can create any specific timing you want. Just add another 30 to the value for each additional sixteenth note in length. 
For example, Soil 1's enemy mix piano plays very rapidly; its timetable uses a value of 90, which looks like <code>005AFFFF</code>. The gestures last for three sixteenth notes. 
You can insert your timetables anywhere at the end of your BMS.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_3.png|Each timetable has a pink box around it.
</gallery>

== Filling in info ==
Once you have your gestures and timetables inserted, go back and fill in those <code>00AAAA</code>, <code>00BBBB</code>, <code>00CCCC</code> placeholders with the locations of your gesture sets, timetables, and gestures you want to use. Remember that gesture sets begin with the <code>00</code>.

Also in the very beginning of your BMS, make sure the value at <code>0x6</code> has the location of where your gesture set list begins (this one will probably be fine), and the value at <code>0x14</code> has the location of where your timing ruleset list begins.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_4.png|Put the location of where the "timing ruleset list" begins here.
</gallery>

== Filling in the conductor file ==
<gallery mode="packed-hover" widths=500px heights=500px>
File:CND_functions.png|Conductor file functions.
</gallery>
In your song's associated conductor file, try to stretch out the window so that the instrument names are all in the same column if you can, like in the image above. 
Each line represents one track. You give each track a instrument (program), and what gesture set and timing ruleset to use. 
The CND infographic above does a good job explaining all the functions, but they'll be explained again down here. 

In the top left corner are three important values:
* The first value is the swing time. <code>1E</code> is 1/16th swing, while <code>3C</code> is 1/8th swing. If your song is below 100bpm, you might want to use <code>1E</code>. If its faster, try <code>3C</code> instead.
* The second value is the tempo, in hex.
* The third value is how many tracks there will be, in hex.

Each column explained:
* A: Initial delay. How many beats until this track starts running. In the vanilla game, you can notice how some song's melodies do not immediately begin playing upon the start of level. This is useful for that; ease the listener into the music.
* B/Q: If set to 1, all gestures will be delayed by an 1/8th note..
* C: Text string. You can make this say whatever you like. Useful for keeping track of what you want each track to be, like "Lead", "Trumpet", "MelodyA"/"MelodyB", "Bass", or "Drums"
* D: Track copy. Select a previous track # to copy the gestures from. If the track its copying plays "gesture 3" from its gesture set, this track will also play its "gesture 3". Often used for treasure mix instruments. You can have them use different gesture sets if you like.
* E: Echo strength.
* F: If set to 1, the values in this track's timetable will always be played in order, in a loop. If set to 0, it will randomly select values from its timetable, thus, allowing you to randomize when gestures play.
* G: Bank number.
* H: Program number. For a list of all programs in the default game and the wScenes that support them, view [[Pikmin 2 custom_music/available instruments|this page]].
* I: Gesture set, select the set # you want to use from the BMS.
* J: Timing ruleset, select the set # you want to use from the BMS.
* K: How many gestures this track will play, before playing "silent gestures". Linked to below. These function as a sort of on/off cycle.
* L: How many "silent gestures" this track will play, before playing normal gestures. Linked to above. These function as a sort of on/off cycle.
* M: If notes are being transposed down (see below), this is set to FF. But this column doesn't actually do anything, so you don't need to edit this.
* N: Transpose all notes played by this track. To transpose up, use values 1-127. To transpose down, use the sign 2 compliment (values 128-255).
* O: Volume.
* P: Stereo panning.
 
Some ideas/considerations:
* You can use the on/off cycle feature (column K and L) to make your melodic instrument "take a break" every once in a while. You can have it play 4 gestures, but then be silent for 2.
* If your timing ruleset is strict (as in, the timings for when gestures occur is always consistent), something fun to try is to have the melody be a back-and-forth between two different instruments. Set the initial delay for the second instrument to be longer than the first one, and then cleverly use the on/off cycle to have the instruments take turns sounding a gesture. This is done for the melody in the Bulblax Kingdom and Frontier Cavern for example.
* If you are using the "track copy" feature (column D), you can have the primary instrument play a melody, and have this instrument always play chords that perfectly match that melody.

== Mapping the tracks ==
With all that done, don't forget to edit the song's [[Trackmap parameters|trackMap]]! Edit your song in the trackMap files in either <code>/user/Totaka</code> or <code>/user/Wakai</code>, and set how many instruments will be in each mix. It goes in order from: Main Mix, Task (event), Treasure (otakara), Enemy near (kehai), Combat mix, and Spiderwort mix (ground). Although you cannot find Spiderworts underground, you will have to sacrifice at least one track for that mix. You cannot set any of the mixes to have 0 instruments in them.

== Bonus: Filenames for brand new CND files ==
If you are adding a brand new CND file instead of replacing an existing one, the prefix will determine which BMS is loaded, and which wScene. Try not to add special characters to filenames, aside from underscores. 

In order to load the correct BMS file, the CND must start with the name of the BMS file.
* "caveconc.cnd", "caveconc_458435.cnd", "caveconc_Waffles.cnd", and "caveconc_Waffles_Song_2.cnd" will all load caveconc.bms. 
* "caverelax.cnd", "caverelax_Gmajor.cnd", and "caverelax_mamuta_dinner.cnd" will all load caverelax.bms. 
* "new_09_4.cnd", "new_09_4000.cnd", and "new_09_portal_PotaTOS.cnd" will load new_09.bms. 

For cavesoil, caveconc, and cavemetal only, the game also checks for an additional "_00", "_05", and "_10" right after the prefix, for the purpose of loading one of three different wScenes. You must include it if you want the correct wScene to load. For example, caveconc_05 loads wScene 31, so if you want your custom song to also load wScene 31, acceptable names include "caveconc_05_WAFFLES.cnd", "caveconc_05_52_46356.cnd", or "caveconc_05_super_boss.cnd". 

After adding your new CND file, be sure to add it to its respective trackMap file.

== Bonus: Adding new content to a vanilla BMS file ==
Adding new hex data in the middle of a file will shift all the offsets that come after it, causing your BMS to jump to the wrong locations, and likely cause a crash if vanilla songs are loaded. 
In order to add new content in addition to what's already in the BMS:
* Find and copy the gesture set list and the timing ruleset list, and paste them at the end of the file. (Separate them with lots of zeros so you have lots more space to add content to these lists)
* Change <code>0x6</code> and <code>0x14</code> to point to your new gesture set list and timing ruleset list. These two values tell the game where the lists are.
The game should now use these brand new lists, instead of the original instances that occur earlier in the file. Since they still contain all the locations of the vanilla gesture sets/timetables from above in the same order, the existing CND songs won't be affected and will continue to function, but now you can expand upon these lists with brand new entries now that you've made the space for them. All new gestures, gesture sets and timetables can be added further down the file.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Editing_vanilla_BMS_file.png|The new gesture set list and timing ruleset list we want to use will be at the bottom.
</gallery>

== Bonus: Adding gesture cutoffs in timetables ==
An intentional compositional choice in some songs is to cutoff gestures while they're in the middle of playing. The most common way this is done is to quickly trigger another gesture; if the last gesture has not finished playing, it will stop playing that gesture and begin playing the new one. It's also possible to add "empty" gestures to gesture sets (like <code>C40000015DFF</code>, a gesture which ends immediately and plays nothing), so you can randomly interrupt gestures in your song with silence, or have there be a chance to play nothing. 
However, if you wish to interrupt gestures in your song at specified times without the randomness, there is a special function in timetables for doing this. In the vanilla game, this is used for the trumpet in [https://www.youtube.com/watch?v=qOhmS1YLpF8 Fire]. The trumpet plays two interrupted gestures, then plays a third gesture in full. Below is the timetable for this trumpet: 
<code>0078 8168 81E0 00F0 80F0 81E0 0780 FFFF</code> 
The trumpet will:
* <code>0078</code> play a gesture for 1 beat
* <code>8168</code> cutoff after this 1 beat
* <code>81E0</code> extend cutoff for another 4 beats
* <code>00F0</code> play a gesture for 2 beats
* <code>80F0</code> cutoff after these 2 beats
* <code>81E0</code> extend cutoff for another 4 beats
* <code>0780</code> play a gesture for 16 beats. 
In order to put a "cutoff" in your timetable:
* Start with how long you want your "playing" gesture to play for, before it gets cutoff. I want the the first gesture to last for one beat (four 1/16th notes), so I'll put <code>0078</code>. Remember that every "30" in decimal is equivalent to a sixteenth note.
* Immediately next in the sequence will be a value that indicates when the cutoff begins. Calculate the difference between "81E0" and the previous value you had just inserted. 81E0 - 0078 = 8168 (in decimal, 33248 - 120 = 33128). I will put <code>8168</code> next in my sequence.
My sequence is now <code>0078 8168 FFFF</code>; this will play a gesture normally for 1 beat, but then immediately cut it off after that 1 beat. 
Putting an additional <code>81E0</code> in the sequence right after will extend the cutoff time for another 4 beats. You can keep putting <code>81E0</code> right after several times in a row if you want the cutoff to last for longer periods.

[[Category:Pikmin 2]]

Creating cave music

2024-03-26T15:44:11Z

Waffles: /* Bonus: Adding gesture cutoffs in timetables */

Randomly generating cave music in Pikmin 2 needs to have two files: a .bms (sequence) file, and a .cnd (conductor) file.

The BMS file type is a sequenced music format used in many games. For the cave music in Pikmin 2 however, it is specially-formatted. It mainly contains many short snippets of musical information to be randomized.

The CND files are the actual "songs"; they take specific groups of snippets from a BMS file, and endlessly puzzle-piece them together to form a coherent piece of music.

This guide will function as a walkthrough for creating your own randomly sequencing cave song. All of the editing will be done in hexadecimal.

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be generating a lot of tiny BMS files, to turn them into "gestures".
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

== Overview of file functions ==
Here are some infographics that you can reference at any time. These show all the functions of a CND file, and all the contents of a BMS file.
<gallery mode="packed-hover" widths=250px heights=250px>
File:CND_functions.png|Conductor file functions.
File:BMS_functions.png|How information is stored in a BMS file.
</gallery>

== Setting up your BMS file ==
Before you begin, set your byte grouping to "3", so every 3 bytes is visually separated by a space. This will make it easier to see stuff. 
Starting with a completely blank BMS file, begin by pasting the following:
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600
</source>
Every cave music BMS begins with this same information.
 
 
== Gesture set list ==
Exactly right after <code>34C600</code> will be a list of every gesture set's location in the BMS. Each entry is the gesture set's hexadecimal location (offset), and each entry in the sequence begins with "<code>00</code>". <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0001B0 0001BF 0001CE 0001D4 0001DA 0001E9 0001F8 0001FE 000204 00020A FFFFFF</code> 
Gesture set "0" will be at offset <code>0x1B0</code>, gesture set "1" will be at offset <code>0x1BF</code>, gesture set "2" will be at <code>0x1CE</code>, and so on. There are a total of 10 gesture sets listed in the above sequence.
 
Until we create our gesture sets, let's use <code>00AAAA</code> as placeholders so we can easily find and get back to this section later on. You can have as many gesture sets as you like; we'll create 16 entries for this tutorial. You may insert this into your BMS: 
<code>00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF</code> 
 
Our BMS should now currently look like this: 
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000
</source>
You can also add an entire row of padding/zeros after this. You can do this for each section, to better visually separate them.
 

== Timing ruleset list ==
This is another sequence of offsets. These just point to the location of a "[[#Inserting_timetables|timetable]]", which will be located at the end of our BMS file. <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0005AB 0005AB 0005AF 0005C1 0005AB 0005AB 0005C1 0005C1 0005C1 0005C1 FFFFFF</code> 
Timing ruleset "0" will use the timetable at <code>0x5AB</code>, timing ruleset "1" will also use the timetable at <code>0x5AB</code>, timing ruleset "2" will use the timetable at <code>0x5AF</code>, and so on. There are a total of 10 timing rulesets listed in the above sequence.
 
Let's use <code>00BBBB</code> as placeholders again, and create 16 of them. Insert this anywhere into your BMS: 
<code>00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB FFFFFF</code> 
 

== Gesture set contents ==
A ''gesture set'' is a group of many gestures. 
Here, we list each gesture set's contents (which are... the locations of gestures!). Each gesture set begins before with <code>00</code> and ends with <code>FFFFFF</code>. 
Here is an example of how the gesture set list should be formatted: 
<code>000210 00022A 000258 000281 FFFFFF 0002B4 0002D9 000303 000331 FFFFFF 000355 FFFFFF 000361 FFFFFF 0003A8 0003C2 0003F0 000419 FFFFFF 00044C 000471 00049B 0004C9 FFFFFF 0004ED FFFFFF 000543 FFFFFF 000580 FFFFFF 00059E FFFFFF</code> 
There are 10 gesture sets listed above. The first gesture set has 4 gestures, located at <code>0x210</code>, <code>0x22A</code>, <code>0x258</code>, and <code>0x281</code>. You can have any amount of gestures in a gesture set; even 1 is fine.
 
You can paste the following placeholder information for now: 
<code>00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC FFFFFF</code> 
It might be a good idea to leave a decent amount of zeros after this list; this one will expand a lot as gestures and gesture sets are added to it.
 

== How is your BMS looking? ==
If you have been copy-pasting everything correctly, your BMS will look something like this:
<gallery mode="packed-hover" widths=300px heights=300px>
File:BMS_file_progress_1.png|Orange is "gesture set list", yellow is "timing ruleset list", and blue is "gesture set contents"
</gallery>
Once again, you can add as much padding between each section as you want, it will work fine.

== Creating gestures ==
First, you should sketch out your song idea in your DAW, and then cut your song into tiny blocks. These blocks will be your song's individual gestures. You should also consider dragging these blocks around in various arrangements to make sure they sound good in any order. 
Once you are ready, have them nicely organized and ready to be exported into individual MIDI files:
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_Pro_gestures.png|A Logic Pro project with a bunch of short blocks of music. Each block will be a "gesture".
</gallery>
For some reason, imported BMS files play 4 times as slow in cave songs. So if you import these gestures as is, they will play 4 times as slow. 
Before you export your gestures, you need to modify your gestures to run ''4 times as fast''. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each block.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>

== Inserting gestures ==
Gestures use same the note/music information as standard BMS songs. 

You should have converted all your MIDIs into BMS files. Open up one of your converted BMS files, and look for the first note/pitch value. If you used [[Pikmin 2 custom music|flaaffy]], this will most likely be somewhere after <code>0x1B</code>, <code>0x1C</code>, or <code>0x1D</code>. The note's pitch value will be followed by a <code>01</code>. Copy this note, all the way to the end of the sequence, which should be <code>FF</code>.
<gallery mode="packed-hover" widths=600px>
File:Copy_pasting_BMS_info.png|The value "2D" here is the hex value of a certain pitch, and the very first note of the sequence. Copy this, all the way to "FF".
</gallery>
To add your gesture, start it with <code>C40000015D</code>, then paste in what you copied. Each gesture should end with that <code>FF</code>. Add as many gestures as you please!
<gallery mode="packed-hover" widths=400px heights=400px>
File:BMS_file_progress_2.png|The purple lines indicate where a gesture starts.
</gallery>

== Inserting timetables ==
So, how do we choose how often gestures will play? Will a gesture play every beat? Every 1/2 a beat? You will need to add a timetable for that!
A timetable is a sequence that dictates when gestures should play. A timetable ends with <code>FFFF</code>. You can make a timetable as complex as you like. Some examples of timetables you can use are: 
* <code>0780FFFF</code> Play a gesture every 16 beats. 
* <code>03C0FFFF</code> Play a gesture every 8 beats. 
* <code>01E0FFFF</code> Play a gesture every 4 beats. 
* <code>03C003C003C001E001E001E001E003C0FFFF</code> This sequence will play a gesture every 8 beats (3x), play a gesture every 4 beats (4x), then play a gesture for 8 beats (1x), in that order. 
* <code>00F0FFFF</code> Play a gesture every 1/2 note (every 2 beats). 
* <code>0078FFFF</code> Play a gesture every 1/4 note (every beat). 
* <code>003CFFFF</code> Play a gesture every 1/8th note. 
* <code>001EFFFF</code> Play a gesture every 1/16th note. 
* <code>003C0078001EFFFF</code> This sequence will play a gesture for an 1/8th note, play a gesture for a 1/4 note, then play a gesture for a 1/16th note, in that order. 
Considering that <code>001E</code> (30 in decimal) is a 1/16th note, you can create any specific timing you want. Just add another 30 to the value for each additional sixteenth note in length. 
For example, Soil 1's enemy mix piano plays very rapidly; its timetable uses a value of 90, which looks like <code>005AFFFF</code>. The gestures last for three sixteenth notes. 
You can insert your timetables anywhere at the end of your BMS.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_3.png|Each timetable has a pink box around it.
</gallery>

== Filling in info ==
Once you have your gestures and timetables inserted, go back and fill in those <code>00AAAA</code>, <code>00BBBB</code>, <code>00CCCC</code> placeholders with the locations of your gesture sets, timetables, and gestures you want to use. Remember that gesture sets begin with the <code>00</code>.

Also in the very beginning of your BMS, make sure the value at <code>0x6</code> has the location of where your gesture set list begins (this one will probably be fine), and the value at <code>0x14</code> has the location of where your timing ruleset list begins.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_4.png|Put the location of where the "timing ruleset list" begins here.
</gallery>

== Filling in the conductor file ==
<gallery mode="packed-hover" widths=500px heights=500px>
File:CND_functions.png|Conductor file functions.
</gallery>
In your song's associated conductor file, try to stretch out the window so that the instrument names are all in the same column if you can, like in the image above. 
Each line represents one track. You give each track a instrument (program), and what gesture set and timing ruleset to use. 
The CND infographic above does a good job explaining all the functions, but they'll be explained again down here. 

In the top left corner are three important values:
* The first value is the swing time. <code>1E</code> is 1/16th swing, while <code>3C</code> is 1/8th swing. If your song is below 100bpm, you might want to use <code>1E</code>. If its faster, try <code>3C</code> instead.
* The second value is the tempo, in hex.
* The third value is how many tracks there will be, in hex.

Each column explained:
* A: Initial delay. How many beats until this track starts running. In the vanilla game, you can notice how some song's melodies do not immediately begin playing upon the start of level. This is useful for that; ease the listener into the music.
* B/Q: If set to 1, all gestures will be delayed by an 1/8th note..
* C: Text string. You can make this say whatever you like. Useful for keeping track of what you want each track to be, like "Lead", "Trumpet", "MelodyA"/"MelodyB", "Bass", or "Drums"
* D: Track copy. Select a previous track # to copy the gestures from. If the track its copying plays "gesture 3" from its gesture set, this track will also play its "gesture 3". Often used for treasure mix instruments. You can have them use different gesture sets if you like.
* E: Echo strength.
* F: If set to 1, the values in this track's timetable will always be played in order, in a loop. If set to 0, it will randomly select values from its timetable, thus, allowing you to randomize when gestures play.
* G: Bank number.
* H: Program number. For a list of all programs in the default game and the wScenes that support them, view [[Pikmin 2 custom_music/available instruments|this page]].
* I: Gesture set, select the set # you want to use from the BMS.
* J: Timing ruleset, select the set # you want to use from the BMS.
* K: How many gestures this track will play, before playing "silent gestures". Linked to below. These function as a sort of on/off cycle.
* L: How many "silent gestures" this track will play, before playing normal gestures. Linked to above. These function as a sort of on/off cycle.
* M: If notes are being transposed down (see below), this is set to FF. But this column doesn't actually do anything, so you don't need to edit this.
* N: Transpose all notes played by this track. To transpose up, use values 1-127. To transpose down, use the sign 2 compliment (values 128-255).
* O: Volume.
* P: Stereo panning.
 
Some ideas/considerations:
* You can use the on/off cycle feature (column K and L) to make your melodic instrument "take a break" every once in a while. You can have it play 4 gestures, but then be silent for 2.
* If your timing ruleset is strict (as in, the timings for when gestures occur is always consistent), something fun to try is to have the melody be a back-and-forth between two different instruments. Set the initial delay for the second instrument to be longer than the first one, and then cleverly use the on/off cycle to have the instruments take turns sounding a gesture. This is done for the melody in the Bulblax Kingdom and Frontier Cavern for example.
* If you are using the "track copy" feature (column D), you can have the primary instrument play a melody, and have this instrument always play chords that perfectly match that melody.

== Mapping the tracks ==
With all that done, don't forget to edit the song's [[Trackmap parameters|trackMap]]! Edit your song in the trackMap files in either <code>/user/Totaka</code> or <code>/user/Wakai</code>, and set how many instruments will be in each mix. It goes in order from: Main Mix, Task (event), Treasure (otakara), Enemy near (kehai), Combat mix, and Spiderwort mix (ground). Although you cannot find Spiderworts underground, you will have to sacrifice at least one track for that mix. You cannot set any of the mixes to have 0 instruments in them.

== Bonus: Filenames for brand new CND files ==
If you are adding a brand new CND file instead of replacing an existing one, the prefix will determine which BMS is loaded, and which wScene. Try not to add special characters to filenames, aside from underscores. 

In order to load the correct BMS file, the CND must start with the name of the BMS file.
* "caveconc.cnd", "caveconc_458435.cnd", "caveconc_Waffles.cnd", and "caveconc_Waffles_Song_2.cnd" will all load caveconc.bms. 
* "caverelax.cnd", "caverelax_Gmajor.cnd", and "caverelax_mamuta_dinner.cnd" will all load caverelax.bms. 
* "new_09_4.cnd", "new_09_4000.cnd", and "new_09_portal_PotaTOS.cnd" will load new_09.bms. 

For cavesoil, caveconc, and cavemetal only, the game also checks for an additional "_00", "_05", and "_10" right after the prefix, for the purpose of loading one of three different wScenes. You must include it if you want the correct wScene to load. For example, caveconc_05 loads wScene 31, so if you want your custom song to also load wScene 31, acceptable names include "caveconc_05_WAFFLES.cnd", "caveconc_05_52_46356.cnd", or "caveconc_05_super_boss.cnd". 

After adding your new CND file, be sure to add it to its respective trackMap file.

== Bonus: Adding new content to a vanilla BMS file ==
Adding new hex data in the middle of a file will shift all the offsets that come after it, causing your BMS to jump to the wrong locations, and likely cause a crash if vanilla songs are loaded. 
In order to add new content in addition to what's already in the BMS:
* Find and copy the gesture set list and the timing ruleset list, and paste them at the end of the file. (Separate them with lots of zeros so you have lots more space to add content to these lists)
* Change <code>0x6</code> and <code>0x14</code> to point to your new gesture set list and timing ruleset list. These two values tell the game where the lists are.
The game should now use these brand new lists, instead of the original instances that occur earlier in the file. Since they still contain all the locations of the vanilla gesture sets/timetables from above in the same order, the existing CND songs won't be affected and will continue to function, but now you can expand upon these lists with brand new entries now that you've made the space for them. All new gestures, gesture sets and timetables can be added further down the file.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Editing_vanilla_BMS_file.png|The new gesture set list and timing ruleset list we want to use will be at the bottom.
</gallery>

== Bonus: Adding gesture cutoffs in timetables ==
An intentional compositional choice in some songs is to cutoff gestures while they're in the middle of playing. The most common way this is done is to quickly trigger another gesture; if the last gesture has not finished playing, it will stop playing that gesture and begin playing the new one. It's also possible to add "empty" gestures to gesture sets (like <code>C40000015DFF</code>, a gesture which ends immediately and plays nothing), so you can randomly interrupt gestures in your song with silence, or have there be a chance to play nothing. 
However, if you wish to interrupt gestures in your song at specified times without the randomness, there is a special function in timetables for doing this. In the vanilla game, this is used for the trumpet in [https://www.youtube.com/watch?v=qOhmS1YLpF8 Fire]. The trumpet plays two interrupted gestures, then plays a third gesture in full. Below is the timetable for this trumpet: 
<code>0078 8168 81E0 00F0 80F0 81E0 0780 FFFF</code> 
The trumpet will:
* <code>0078</code> play a gesture for 1 beat
* <code>8168</code> cutoff after this 1 beat
* <code>81E0</code> extend cutoff for another 4 beats
* <code>00F0</code> play a gesture for 2 beats
* <code>80F0</code> cutoff after these 2 beats
* <code>81E0</code> extend cutoff for another 4 beats
* <code>0780</code> play a gesture for 16 beats. 
In order to put a "cutoff" in your timetable:
* Start with how long you want your "playing" gesture to play for, before it gets cutoff. I want the the first gesture to last for one beat (four 1/16th notes), so I'll put <code>0078</code>. Remember that every "30" in decimal is equivalent to a sixteenth note.
* Immediately next in the sequence will be a value that indicates when the cutoff begins. Calculate the difference between "81E0" and the previous value you had just inserted. 81E0 - 0078 = 8168 (in decimal, 33248 - 120 = 33128). I will put <code>8168</code> next in my sequence.
My sequence is now <code>0078 8168 FFFF</code>; this will play a gesture normally for 1 beat, but then immediately cut it off after that 1 beat. 
Putting an additional <code>81E0</code> in the sequence right after will extend the cutoff time for another 4 beats. You can repeat <code>81E0</code> several times in a row if you want the cutoff to last for long periods.

[[Category:Pikmin 2]]

Creating cave music

2024-03-26T15:42:42Z

Waffles: /* Bonus: Adding gesture cutoffs in timetables */

Randomly generating cave music in Pikmin 2 needs to have two files: a .bms (sequence) file, and a .cnd (conductor) file.

The BMS file type is a sequenced music format used in many games. For the cave music in Pikmin 2 however, it is specially-formatted. It mainly contains many short snippets of musical information to be randomized.

The CND files are the actual "songs"; they take specific groups of snippets from a BMS file, and endlessly puzzle-piece them together to form a coherent piece of music.

This guide will function as a walkthrough for creating your own randomly sequencing cave song. All of the editing will be done in hexadecimal.

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be generating a lot of tiny BMS files, to turn them into "gestures".
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

== Overview of file functions ==
Here are some infographics that you can reference at any time. These show all the functions of a CND file, and all the contents of a BMS file.
<gallery mode="packed-hover" widths=250px heights=250px>
File:CND_functions.png|Conductor file functions.
File:BMS_functions.png|How information is stored in a BMS file.
</gallery>

== Setting up your BMS file ==
Before you begin, set your byte grouping to "3", so every 3 bytes is visually separated by a space. This will make it easier to see stuff. 
Starting with a completely blank BMS file, begin by pasting the following:
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600
</source>
Every cave music BMS begins with this same information.
 
 
== Gesture set list ==
Exactly right after <code>34C600</code> will be a list of every gesture set's location in the BMS. Each entry is the gesture set's hexadecimal location (offset), and each entry in the sequence begins with "<code>00</code>". <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0001B0 0001BF 0001CE 0001D4 0001DA 0001E9 0001F8 0001FE 000204 00020A FFFFFF</code> 
Gesture set "0" will be at offset <code>0x1B0</code>, gesture set "1" will be at offset <code>0x1BF</code>, gesture set "2" will be at <code>0x1CE</code>, and so on. There are a total of 10 gesture sets listed in the above sequence.
 
Until we create our gesture sets, let's use <code>00AAAA</code> as placeholders so we can easily find and get back to this section later on. You can have as many gesture sets as you like; we'll create 16 entries for this tutorial. You may insert this into your BMS: 
<code>00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF</code> 
 
Our BMS should now currently look like this: 
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000
</source>
You can also add an entire row of padding/zeros after this. You can do this for each section, to better visually separate them.
 

== Timing ruleset list ==
This is another sequence of offsets. These just point to the location of a "[[#Inserting_timetables|timetable]]", which will be located at the end of our BMS file. <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0005AB 0005AB 0005AF 0005C1 0005AB 0005AB 0005C1 0005C1 0005C1 0005C1 FFFFFF</code> 
Timing ruleset "0" will use the timetable at <code>0x5AB</code>, timing ruleset "1" will also use the timetable at <code>0x5AB</code>, timing ruleset "2" will use the timetable at <code>0x5AF</code>, and so on. There are a total of 10 timing rulesets listed in the above sequence.
 
Let's use <code>00BBBB</code> as placeholders again, and create 16 of them. Insert this anywhere into your BMS: 
<code>00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB FFFFFF</code> 
 

== Gesture set contents ==
A ''gesture set'' is a group of many gestures. 
Here, we list each gesture set's contents (which are... the locations of gestures!). Each gesture set begins before with <code>00</code> and ends with <code>FFFFFF</code>. 
Here is an example of how the gesture set list should be formatted: 
<code>000210 00022A 000258 000281 FFFFFF 0002B4 0002D9 000303 000331 FFFFFF 000355 FFFFFF 000361 FFFFFF 0003A8 0003C2 0003F0 000419 FFFFFF 00044C 000471 00049B 0004C9 FFFFFF 0004ED FFFFFF 000543 FFFFFF 000580 FFFFFF 00059E FFFFFF</code> 
There are 10 gesture sets listed above. The first gesture set has 4 gestures, located at <code>0x210</code>, <code>0x22A</code>, <code>0x258</code>, and <code>0x281</code>. You can have any amount of gestures in a gesture set; even 1 is fine.
 
You can paste the following placeholder information for now: 
<code>00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC FFFFFF</code> 
It might be a good idea to leave a decent amount of zeros after this list; this one will expand a lot as gestures and gesture sets are added to it.
 

== How is your BMS looking? ==
If you have been copy-pasting everything correctly, your BMS will look something like this:
<gallery mode="packed-hover" widths=300px heights=300px>
File:BMS_file_progress_1.png|Orange is "gesture set list", yellow is "timing ruleset list", and blue is "gesture set contents"
</gallery>
Once again, you can add as much padding between each section as you want, it will work fine.

== Creating gestures ==
First, you should sketch out your song idea in your DAW, and then cut your song into tiny blocks. These blocks will be your song's individual gestures. You should also consider dragging these blocks around in various arrangements to make sure they sound good in any order. 
Once you are ready, have them nicely organized and ready to be exported into individual MIDI files:
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_Pro_gestures.png|A Logic Pro project with a bunch of short blocks of music. Each block will be a "gesture".
</gallery>
For some reason, imported BMS files play 4 times as slow in cave songs. So if you import these gestures as is, they will play 4 times as slow. 
Before you export your gestures, you need to modify your gestures to run ''4 times as fast''. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each block.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>

== Inserting gestures ==
Gestures use same the note/music information as standard BMS songs. 

You should have converted all your MIDIs into BMS files. Open up one of your converted BMS files, and look for the first note/pitch value. If you used [[Pikmin 2 custom music|flaaffy]], this will most likely be somewhere after <code>0x1B</code>, <code>0x1C</code>, or <code>0x1D</code>. The note's pitch value will be followed by a <code>01</code>. Copy this note, all the way to the end of the sequence, which should be <code>FF</code>.
<gallery mode="packed-hover" widths=600px>
File:Copy_pasting_BMS_info.png|The value "2D" here is the hex value of a certain pitch, and the very first note of the sequence. Copy this, all the way to "FF".
</gallery>
To add your gesture, start it with <code>C40000015D</code>, then paste in what you copied. Each gesture should end with that <code>FF</code>. Add as many gestures as you please!
<gallery mode="packed-hover" widths=400px heights=400px>
File:BMS_file_progress_2.png|The purple lines indicate where a gesture starts.
</gallery>

== Inserting timetables ==
So, how do we choose how often gestures will play? Will a gesture play every beat? Every 1/2 a beat? You will need to add a timetable for that!
A timetable is a sequence that dictates when gestures should play. A timetable ends with <code>FFFF</code>. You can make a timetable as complex as you like. Some examples of timetables you can use are: 
* <code>0780FFFF</code> Play a gesture every 16 beats. 
* <code>03C0FFFF</code> Play a gesture every 8 beats. 
* <code>01E0FFFF</code> Play a gesture every 4 beats. 
* <code>03C003C003C001E001E001E001E003C0FFFF</code> This sequence will play a gesture every 8 beats (3x), play a gesture every 4 beats (4x), then play a gesture for 8 beats (1x), in that order. 
* <code>00F0FFFF</code> Play a gesture every 1/2 note (every 2 beats). 
* <code>0078FFFF</code> Play a gesture every 1/4 note (every beat). 
* <code>003CFFFF</code> Play a gesture every 1/8th note. 
* <code>001EFFFF</code> Play a gesture every 1/16th note. 
* <code>003C0078001EFFFF</code> This sequence will play a gesture for an 1/8th note, play a gesture for a 1/4 note, then play a gesture for a 1/16th note, in that order. 
Considering that <code>001E</code> (30 in decimal) is a 1/16th note, you can create any specific timing you want. Just add another 30 to the value for each additional sixteenth note in length. 
For example, Soil 1's enemy mix piano plays very rapidly; its timetable uses a value of 90, which looks like <code>005AFFFF</code>. The gestures last for three sixteenth notes. 
You can insert your timetables anywhere at the end of your BMS.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_3.png|Each timetable has a pink box around it.
</gallery>

== Filling in info ==
Once you have your gestures and timetables inserted, go back and fill in those <code>00AAAA</code>, <code>00BBBB</code>, <code>00CCCC</code> placeholders with the locations of your gesture sets, timetables, and gestures you want to use. Remember that gesture sets begin with the <code>00</code>.

Also in the very beginning of your BMS, make sure the value at <code>0x6</code> has the location of where your gesture set list begins (this one will probably be fine), and the value at <code>0x14</code> has the location of where your timing ruleset list begins.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_4.png|Put the location of where the "timing ruleset list" begins here.
</gallery>

== Filling in the conductor file ==
<gallery mode="packed-hover" widths=500px heights=500px>
File:CND_functions.png|Conductor file functions.
</gallery>
In your song's associated conductor file, try to stretch out the window so that the instrument names are all in the same column if you can, like in the image above. 
Each line represents one track. You give each track a instrument (program), and what gesture set and timing ruleset to use. 
The CND infographic above does a good job explaining all the functions, but they'll be explained again down here. 

In the top left corner are three important values:
* The first value is the swing time. <code>1E</code> is 1/16th swing, while <code>3C</code> is 1/8th swing. If your song is below 100bpm, you might want to use <code>1E</code>. If its faster, try <code>3C</code> instead.
* The second value is the tempo, in hex.
* The third value is how many tracks there will be, in hex.

Each column explained:
* A: Initial delay. How many beats until this track starts running. In the vanilla game, you can notice how some song's melodies do not immediately begin playing upon the start of level. This is useful for that; ease the listener into the music.
* B/Q: If set to 1, all gestures will be delayed by an 1/8th note..
* C: Text string. You can make this say whatever you like. Useful for keeping track of what you want each track to be, like "Lead", "Trumpet", "MelodyA"/"MelodyB", "Bass", or "Drums"
* D: Track copy. Select a previous track # to copy the gestures from. If the track its copying plays "gesture 3" from its gesture set, this track will also play its "gesture 3". Often used for treasure mix instruments. You can have them use different gesture sets if you like.
* E: Echo strength.
* F: If set to 1, the values in this track's timetable will always be played in order, in a loop. If set to 0, it will randomly select values from its timetable, thus, allowing you to randomize when gestures play.
* G: Bank number.
* H: Program number. For a list of all programs in the default game and the wScenes that support them, view [[Pikmin 2 custom_music/available instruments|this page]].
* I: Gesture set, select the set # you want to use from the BMS.
* J: Timing ruleset, select the set # you want to use from the BMS.
* K: How many gestures this track will play, before playing "silent gestures". Linked to below. These function as a sort of on/off cycle.
* L: How many "silent gestures" this track will play, before playing normal gestures. Linked to above. These function as a sort of on/off cycle.
* M: If notes are being transposed down (see below), this is set to FF. But this column doesn't actually do anything, so you don't need to edit this.
* N: Transpose all notes played by this track. To transpose up, use values 1-127. To transpose down, use the sign 2 compliment (values 128-255).
* O: Volume.
* P: Stereo panning.
 
Some ideas/considerations:
* You can use the on/off cycle feature (column K and L) to make your melodic instrument "take a break" every once in a while. You can have it play 4 gestures, but then be silent for 2.
* If your timing ruleset is strict (as in, the timings for when gestures occur is always consistent), something fun to try is to have the melody be a back-and-forth between two different instruments. Set the initial delay for the second instrument to be longer than the first one, and then cleverly use the on/off cycle to have the instruments take turns sounding a gesture. This is done for the melody in the Bulblax Kingdom and Frontier Cavern for example.
* If you are using the "track copy" feature (column D), you can have the primary instrument play a melody, and have this instrument always play chords that perfectly match that melody.

== Mapping the tracks ==
With all that done, don't forget to edit the song's [[Trackmap parameters|trackMap]]! Edit your song in the trackMap files in either <code>/user/Totaka</code> or <code>/user/Wakai</code>, and set how many instruments will be in each mix. It goes in order from: Main Mix, Task (event), Treasure (otakara), Enemy near (kehai), Combat mix, and Spiderwort mix (ground). Although you cannot find Spiderworts underground, you will have to sacrifice at least one track for that mix. You cannot set any of the mixes to have 0 instruments in them.

== Bonus: Filenames for brand new CND files ==
If you are adding a brand new CND file instead of replacing an existing one, the prefix will determine which BMS is loaded, and which wScene. Try not to add special characters to filenames, aside from underscores. 

In order to load the correct BMS file, the CND must start with the name of the BMS file.
* "caveconc.cnd", "caveconc_458435.cnd", "caveconc_Waffles.cnd", and "caveconc_Waffles_Song_2.cnd" will all load caveconc.bms. 
* "caverelax.cnd", "caverelax_Gmajor.cnd", and "caverelax_mamuta_dinner.cnd" will all load caverelax.bms. 
* "new_09_4.cnd", "new_09_4000.cnd", and "new_09_portal_PotaTOS.cnd" will load new_09.bms. 

For cavesoil, caveconc, and cavemetal only, the game also checks for an additional "_00", "_05", and "_10" right after the prefix, for the purpose of loading one of three different wScenes. You must include it if you want the correct wScene to load. For example, caveconc_05 loads wScene 31, so if you want your custom song to also load wScene 31, acceptable names include "caveconc_05_WAFFLES.cnd", "caveconc_05_52_46356.cnd", or "caveconc_05_super_boss.cnd". 

After adding your new CND file, be sure to add it to its respective trackMap file.

== Bonus: Adding new content to a vanilla BMS file ==
Adding new hex data in the middle of a file will shift all the offsets that come after it, causing your BMS to jump to the wrong locations, and likely cause a crash if vanilla songs are loaded. 
In order to add new content in addition to what's already in the BMS:
* Find and copy the gesture set list and the timing ruleset list, and paste them at the end of the file. (Separate them with lots of zeros so you have lots more space to add content to these lists)
* Change <code>0x6</code> and <code>0x14</code> to point to your new gesture set list and timing ruleset list. These two values tell the game where the lists are.
The game should now use these brand new lists, instead of the original instances that occur earlier in the file. Since they still contain all the locations of the vanilla gesture sets/timetables from above in the same order, the existing CND songs won't be affected and will continue to function, but now you can expand upon these lists with brand new entries now that you've made the space for them. All new gestures, gesture sets and timetables can be added further down the file.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Editing_vanilla_BMS_file.png|The new gesture set list and timing ruleset list we want to use will be at the bottom.
</gallery>

== Bonus: Adding gesture cutoffs in timetables ==
An intentional compositional choice in some songs is to cutoff gestures while they're in the middle of playing. The most common way this is done is to quickly trigger another gesture; if the last gesture has not finished playing, it will stop playing that gesture and begin playing the new one. It's also possible to add "empty" gestures to gesture sets (like <code>C40000015DFF</code>, a gesture which ends immediately and plays nothing), so you can randomly interrupt gestures in your song with silence, or have there be a chance to play nothing. 
However, if you wish to interrupt gestures in your song at specified times without the randomness, there is a special function in timetables for doing this. In the vanilla game, this is used for the trumpet in [https://www.youtube.com/watch?v=qOhmS1YLpF8 Fire]. The trumpet plays two interrupted gestures, then plays a third gesture in full. Below is the timetable for this trumpet: 
<code>0078 8168 81E0 00F0 80F0 81E0 0780 FFFF</code> 
The trumpet will:
* <code>0078</code> play a gesture for 1 beat
* <code>8168</code> cutoff after this 1 beat
* <code>81E0</code> extend cutoff for another 4 beats
* <code>00F0</code> play a gesture for 2 beats
* <code>80F0</code> cutoff after these 2 beats
* <code>81E0</code> extend cutoff for another 4 beats
* <code>0780</code> play a gesture for 16 beats. 
In order to put a "cutoff" in your timetable:
* Start with how long you want your "playing" gesture to play for, before it gets cutoff. I want the the first gesture to last for one beat (four 1/16th notes), so I'll put <code>0078</code>. Remember that every "30" in decimal is equivalent to a sixteenth note.
* Immediately next in the sequence will be a value that indicates when the cutoff begins. Calculate the difference between "81E0" and the previous value you had just inserted. 81E0 - 0078 = 8168 (in decimal, 33248 - 120 = 33128). I will put <code>8168</code> next in my sequence.
My sequence is now <code>0078 8168 FFFF</code>; this will play a gesture normally for 1 beat, but then immediately cut it off after that 1 beat. 
Putting an additional <code>81E0</code> in the sequence right after will extend the cutoff time for another 4 beats. You can repeat it several times in a row if you want the cutoff to last for long periods.

[[Category:Pikmin 2]]

Creating cave music

2024-03-26T15:36:17Z

Waffles: Bonus: cutoff gestures

Randomly generating cave music in Pikmin 2 needs to have two files: a .bms (sequence) file, and a .cnd (conductor) file.

The BMS file type is a sequenced music format used in many games. For the cave music in Pikmin 2 however, it is specially-formatted. It mainly contains many short snippets of musical information to be randomized.

The CND files are the actual "songs"; they take specific groups of snippets from a BMS file, and endlessly puzzle-piece them together to form a coherent piece of music.

This guide will function as a walkthrough for creating your own randomly sequencing cave song. All of the editing will be done in hexadecimal.

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be generating a lot of tiny BMS files, to turn them into "gestures".
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

== Overview of file functions ==
Here are some infographics that you can reference at any time. These show all the functions of a CND file, and all the contents of a BMS file.
<gallery mode="packed-hover" widths=250px heights=250px>
File:CND_functions.png|Conductor file functions.
File:BMS_functions.png|How information is stored in a BMS file.
</gallery>

== Setting up your BMS file ==
Before you begin, set your byte grouping to "3", so every 3 bytes is visually separated by a space. This will make it easier to see stuff. 
Starting with a completely blank BMS file, begin by pasting the following:
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600
</source>
Every cave music BMS begins with this same information.
 
 
== Gesture set list ==
Exactly right after <code>34C600</code> will be a list of every gesture set's location in the BMS. Each entry is the gesture set's hexadecimal location (offset), and each entry in the sequence begins with "<code>00</code>". <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0001B0 0001BF 0001CE 0001D4 0001DA 0001E9 0001F8 0001FE 000204 00020A FFFFFF</code> 
Gesture set "0" will be at offset <code>0x1B0</code>, gesture set "1" will be at offset <code>0x1BF</code>, gesture set "2" will be at <code>0x1CE</code>, and so on. There are a total of 10 gesture sets listed in the above sequence.
 
Until we create our gesture sets, let's use <code>00AAAA</code> as placeholders so we can easily find and get back to this section later on. You can have as many gesture sets as you like; we'll create 16 entries for this tutorial. You may insert this into your BMS: 
<code>00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF</code> 
 
Our BMS should now currently look like this: 
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000
</source>
You can also add an entire row of padding/zeros after this. You can do this for each section, to better visually separate them.
 

== Timing ruleset list ==
This is another sequence of offsets. These just point to the location of a "[[#Inserting_timetables|timetable]]", which will be located at the end of our BMS file. <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0005AB 0005AB 0005AF 0005C1 0005AB 0005AB 0005C1 0005C1 0005C1 0005C1 FFFFFF</code> 
Timing ruleset "0" will use the timetable at <code>0x5AB</code>, timing ruleset "1" will also use the timetable at <code>0x5AB</code>, timing ruleset "2" will use the timetable at <code>0x5AF</code>, and so on. There are a total of 10 timing rulesets listed in the above sequence.
 
Let's use <code>00BBBB</code> as placeholders again, and create 16 of them. Insert this anywhere into your BMS: 
<code>00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB FFFFFF</code> 
 

== Gesture set contents ==
A ''gesture set'' is a group of many gestures. 
Here, we list each gesture set's contents (which are... the locations of gestures!). Each gesture set begins before with <code>00</code> and ends with <code>FFFFFF</code>. 
Here is an example of how the gesture set list should be formatted: 
<code>000210 00022A 000258 000281 FFFFFF 0002B4 0002D9 000303 000331 FFFFFF 000355 FFFFFF 000361 FFFFFF 0003A8 0003C2 0003F0 000419 FFFFFF 00044C 000471 00049B 0004C9 FFFFFF 0004ED FFFFFF 000543 FFFFFF 000580 FFFFFF 00059E FFFFFF</code> 
There are 10 gesture sets listed above. The first gesture set has 4 gestures, located at <code>0x210</code>, <code>0x22A</code>, <code>0x258</code>, and <code>0x281</code>. You can have any amount of gestures in a gesture set; even 1 is fine.
 
You can paste the following placeholder information for now: 
<code>00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC FFFFFF</code> 
It might be a good idea to leave a decent amount of zeros after this list; this one will expand a lot as gestures and gesture sets are added to it.
 

== How is your BMS looking? ==
If you have been copy-pasting everything correctly, your BMS will look something like this:
<gallery mode="packed-hover" widths=300px heights=300px>
File:BMS_file_progress_1.png|Orange is "gesture set list", yellow is "timing ruleset list", and blue is "gesture set contents"
</gallery>
Once again, you can add as much padding between each section as you want, it will work fine.

== Creating gestures ==
First, you should sketch out your song idea in your DAW, and then cut your song into tiny blocks. These blocks will be your song's individual gestures. You should also consider dragging these blocks around in various arrangements to make sure they sound good in any order. 
Once you are ready, have them nicely organized and ready to be exported into individual MIDI files:
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_Pro_gestures.png|A Logic Pro project with a bunch of short blocks of music. Each block will be a "gesture".
</gallery>
For some reason, imported BMS files play 4 times as slow in cave songs. So if you import these gestures as is, they will play 4 times as slow. 
Before you export your gestures, you need to modify your gestures to run ''4 times as fast''. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each block.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>

== Inserting gestures ==
Gestures use same the note/music information as standard BMS songs. 

You should have converted all your MIDIs into BMS files. Open up one of your converted BMS files, and look for the first note/pitch value. If you used [[Pikmin 2 custom music|flaaffy]], this will most likely be somewhere after <code>0x1B</code>, <code>0x1C</code>, or <code>0x1D</code>. The note's pitch value will be followed by a <code>01</code>. Copy this note, all the way to the end of the sequence, which should be <code>FF</code>.
<gallery mode="packed-hover" widths=600px>
File:Copy_pasting_BMS_info.png|The value "2D" here is the hex value of a certain pitch, and the very first note of the sequence. Copy this, all the way to "FF".
</gallery>
To add your gesture, start it with <code>C40000015D</code>, then paste in what you copied. Each gesture should end with that <code>FF</code>. Add as many gestures as you please!
<gallery mode="packed-hover" widths=400px heights=400px>
File:BMS_file_progress_2.png|The purple lines indicate where a gesture starts.
</gallery>

== Inserting timetables ==
So, how do we choose how often gestures will play? Will a gesture play every beat? Every 1/2 a beat? You will need to add a timetable for that!
A timetable is a sequence that dictates when gestures should play. A timetable ends with <code>FFFF</code>. You can make a timetable as complex as you like. Some examples of timetables you can use are: 
* <code>0780FFFF</code> Play a gesture every 16 beats. 
* <code>03C0FFFF</code> Play a gesture every 8 beats. 
* <code>01E0FFFF</code> Play a gesture every 4 beats. 
* <code>03C003C003C001E001E001E001E003C0FFFF</code> This sequence will play a gesture every 8 beats (3x), play a gesture every 4 beats (4x), then play a gesture for 8 beats (1x), in that order. 
* <code>00F0FFFF</code> Play a gesture every 1/2 note (every 2 beats). 
* <code>0078FFFF</code> Play a gesture every 1/4 note (every beat). 
* <code>003CFFFF</code> Play a gesture every 1/8th note. 
* <code>001EFFFF</code> Play a gesture every 1/16th note. 
* <code>003C0078001EFFFF</code> This sequence will play a gesture for an 1/8th note, play a gesture for a 1/4 note, then play a gesture for a 1/16th note, in that order. 
Considering that <code>001E</code> (30 in decimal) is a 1/16th note, you can create any specific timing you want. Just add another 30 to the value for each additional sixteenth note in length. 
For example, Soil 1's enemy mix piano plays very rapidly; its timetable uses a value of 90, which looks like <code>005AFFFF</code>. The gestures last for three sixteenth notes. 
You can insert your timetables anywhere at the end of your BMS.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_3.png|Each timetable has a pink box around it.
</gallery>

== Filling in info ==
Once you have your gestures and timetables inserted, go back and fill in those <code>00AAAA</code>, <code>00BBBB</code>, <code>00CCCC</code> placeholders with the locations of your gesture sets, timetables, and gestures you want to use. Remember that gesture sets begin with the <code>00</code>.

Also in the very beginning of your BMS, make sure the value at <code>0x6</code> has the location of where your gesture set list begins (this one will probably be fine), and the value at <code>0x14</code> has the location of where your timing ruleset list begins.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_4.png|Put the location of where the "timing ruleset list" begins here.
</gallery>

== Filling in the conductor file ==
<gallery mode="packed-hover" widths=500px heights=500px>
File:CND_functions.png|Conductor file functions.
</gallery>
In your song's associated conductor file, try to stretch out the window so that the instrument names are all in the same column if you can, like in the image above. 
Each line represents one track. You give each track a instrument (program), and what gesture set and timing ruleset to use. 
The CND infographic above does a good job explaining all the functions, but they'll be explained again down here. 

In the top left corner are three important values:
* The first value is the swing time. <code>1E</code> is 1/16th swing, while <code>3C</code> is 1/8th swing. If your song is below 100bpm, you might want to use <code>1E</code>. If its faster, try <code>3C</code> instead.
* The second value is the tempo, in hex.
* The third value is how many tracks there will be, in hex.

Each column explained:
* A: Initial delay. How many beats until this track starts running. In the vanilla game, you can notice how some song's melodies do not immediately begin playing upon the start of level. This is useful for that; ease the listener into the music.
* B/Q: If set to 1, all gestures will be delayed by an 1/8th note..
* C: Text string. You can make this say whatever you like. Useful for keeping track of what you want each track to be, like "Lead", "Trumpet", "MelodyA"/"MelodyB", "Bass", or "Drums"
* D: Track copy. Select a previous track # to copy the gestures from. If the track its copying plays "gesture 3" from its gesture set, this track will also play its "gesture 3". Often used for treasure mix instruments. You can have them use different gesture sets if you like.
* E: Echo strength.
* F: If set to 1, the values in this track's timetable will always be played in order, in a loop. If set to 0, it will randomly select values from its timetable, thus, allowing you to randomize when gestures play.
* G: Bank number.
* H: Program number. For a list of all programs in the default game and the wScenes that support them, view [[Pikmin 2 custom_music/available instruments|this page]].
* I: Gesture set, select the set # you want to use from the BMS.
* J: Timing ruleset, select the set # you want to use from the BMS.
* K: How many gestures this track will play, before playing "silent gestures". Linked to below. These function as a sort of on/off cycle.
* L: How many "silent gestures" this track will play, before playing normal gestures. Linked to above. These function as a sort of on/off cycle.
* M: If notes are being transposed down (see below), this is set to FF. But this column doesn't actually do anything, so you don't need to edit this.
* N: Transpose all notes played by this track. To transpose up, use values 1-127. To transpose down, use the sign 2 compliment (values 128-255).
* O: Volume.
* P: Stereo panning.
 
Some ideas/considerations:
* You can use the on/off cycle feature (column K and L) to make your melodic instrument "take a break" every once in a while. You can have it play 4 gestures, but then be silent for 2.
* If your timing ruleset is strict (as in, the timings for when gestures occur is always consistent), something fun to try is to have the melody be a back-and-forth between two different instruments. Set the initial delay for the second instrument to be longer than the first one, and then cleverly use the on/off cycle to have the instruments take turns sounding a gesture. This is done for the melody in the Bulblax Kingdom and Frontier Cavern for example.
* If you are using the "track copy" feature (column D), you can have the primary instrument play a melody, and have this instrument always play chords that perfectly match that melody.

== Mapping the tracks ==
With all that done, don't forget to edit the song's [[Trackmap parameters|trackMap]]! Edit your song in the trackMap files in either <code>/user/Totaka</code> or <code>/user/Wakai</code>, and set how many instruments will be in each mix. It goes in order from: Main Mix, Task (event), Treasure (otakara), Enemy near (kehai), Combat mix, and Spiderwort mix (ground). Although you cannot find Spiderworts underground, you will have to sacrifice at least one track for that mix. You cannot set any of the mixes to have 0 instruments in them.

== Bonus: Filenames for brand new CND files ==
If you are adding a brand new CND file instead of replacing an existing one, the prefix will determine which BMS is loaded, and which wScene. Try not to add special characters to filenames, aside from underscores. 

In order to load the correct BMS file, the CND must start with the name of the BMS file.
* "caveconc.cnd", "caveconc_458435.cnd", "caveconc_Waffles.cnd", and "caveconc_Waffles_Song_2.cnd" will all load caveconc.bms. 
* "caverelax.cnd", "caverelax_Gmajor.cnd", and "caverelax_mamuta_dinner.cnd" will all load caverelax.bms. 
* "new_09_4.cnd", "new_09_4000.cnd", and "new_09_portal_PotaTOS.cnd" will load new_09.bms. 

For cavesoil, caveconc, and cavemetal only, the game also checks for an additional "_00", "_05", and "_10" right after the prefix, for the purpose of loading one of three different wScenes. You must include it if you want the correct wScene to load. For example, caveconc_05 loads wScene 31, so if you want your custom song to also load wScene 31, acceptable names include "caveconc_05_WAFFLES.cnd", "caveconc_05_52_46356.cnd", or "caveconc_05_super_boss.cnd". 

After adding your new CND file, be sure to add it to its respective trackMap file.

== Bonus: Adding new content to a vanilla BMS file ==
Adding new hex data in the middle of a file will shift all the offsets that come after it, causing your BMS to jump to the wrong locations, and likely cause a crash if vanilla songs are loaded. 
In order to add new content in addition to what's already in the BMS:
* Find and copy the gesture set list and the timing ruleset list, and paste them at the end of the file. (Separate them with lots of zeros so you have lots more space to add content to these lists)
* Change <code>0x6</code> and <code>0x14</code> to point to your new gesture set list and timing ruleset list. These two values tell the game where the lists are.
The game should now use these brand new lists, instead of the original instances that occur earlier in the file. Since they still contain all the locations of the vanilla gesture sets/timetables from above in the same order, the existing CND songs won't be affected and will continue to function, but now you can expand upon these lists with brand new entries now that you've made the space for them. All new gestures, gesture sets and timetables can be added further down the file.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Editing_vanilla_BMS_file.png|The new gesture set list and timing ruleset list we want to use will be at the bottom.
</gallery>

== Bonus: Adding gesture cutoffs in timetables ==
An intentional compositional choice in some songs is to cutoff gestures while they're in the middle of playing. The most common way this is done is to quickly trigger another gesture; if the last gesture has not finished playing, it will stop playing that gesture and begin playing the new one. It's also possible to add "empty" gestures to gesture sets (like <code>C40000015DFF</code>, a gesture which ends immediately and plays nothing), so you can randomly interrupt gestures in your song with silence, or have there be a chance to play nothing. 
However, if you wish to interrupt gestures in your song at specified times without the randomness, there is a special function in timetables for doing this. In the vanilla game, this is used for the trumpet in [https://www.youtube.com/watch?v=qOhmS1YLpF8 Fire]. The trumpet plays two interrupted gestures, then plays a third gesture in full. Below is the timetable for this trumpet: 
<code>0078 8168 81E0 00F0 80F0 81E0 0780 FFFF</code> 
The trumpet will: play a gesture for 1 beat, cutoff after this 1 beat, cutoff for 4 beats, play a gesture for 2 beats, cutoff after these 2 beats, cutoff for 4 beats, then play a gesture for 16 beats. 
In order to put a "cutoff" in your timetable:
* Start with how long you want your "playing" gesture to play for, before it gets cutoff. I want the the first gesture to last for one beat (four 1/16th notes), so I'll put <code>0078</code>. Remember that every "30" in decimal is equivalent to a sixteenth note.
* Immediately next in the sequence will be a value that indicates when the cutoff begins. Calculate the difference between <code>81E0</code> and the previous value you just put in your sequence. 81E0 - 0078 = 8168 (in decimal, 33248 - 120 = 33128).
My sequence is now <code>0078 8168</code>; this will play a gesture normally for 1 beat, but then immediately cut it off after that 1 beat. 
Putting an additional <code>81E0</code> in the sequence right after will extend the cutoff time for another 4 beats. You can repeat it several times in a row if you want the cutoff to last for long periods.

[[Category:Pikmin 2]]

File:BMS functions.png

2024-03-17T04:12:45Z

Waffles: Waffles uploaded a new version of File:BMS functions.png

== Summary ==
Infographic showing cave music BMS file functions.

Creating cave music

2024-03-11T18:17:37Z

Waffles: /* Bonus: Adding new content to a vanilla BMS file */

Randomly generating cave music in Pikmin 2 needs to have two files: a .bms (sequence) file, and a .cnd (conductor) file.

The BMS file type is a sequenced music format used in many games. For the cave music in Pikmin 2 however, it is specially-formatted. It mainly contains many short snippets of musical information to be randomized.

The CND files are the actual "songs"; they take specific groups of snippets from a BMS file, and endlessly puzzle-piece them together to form a coherent piece of music.

This guide will function as a walkthrough for creating your own randomly sequencing cave song. All of the editing will be done in hexadecimal.

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be generating a lot of tiny BMS files, to turn them into "gestures".
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

== Overview of file functions ==
Here are some infographics that you can reference at any time. These show all the functions of a CND file, and all the contents of a BMS file.
<gallery mode="packed-hover" widths=250px heights=250px>
File:CND_functions.png|Conductor file functions.
File:BMS_functions.png|How information is stored in a BMS file.
</gallery>

== Setting up your BMS file ==
Before you begin, set your byte grouping to "3", so every 3 bytes is visually separated by a space. This will make it easier to see stuff. 
Starting with a completely blank BMS file, begin by pasting the following:
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600
</source>
Every cave music BMS begins with this same information.
 
 
== Gesture set list ==
Exactly right after <code>34C600</code> will be a list of every gesture set's location in the BMS. Each entry is the gesture set's hexadecimal location (offset), and each entry in the sequence begins with "<code>00</code>". <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0001B0 0001BF 0001CE 0001D4 0001DA 0001E9 0001F8 0001FE 000204 00020A FFFFFF</code> 
Gesture set "0" will be at offset <code>0x1B0</code>, gesture set "1" will be at offset <code>0x1BF</code>, gesture set "2" will be at <code>0x1CE</code>, and so on. There are a total of 10 gesture sets listed in the above sequence.
 
Until we create our gesture sets, let's use <code>00AAAA</code> as placeholders so we can easily find and get back to this section later on. You can have as many gesture sets as you like; we'll create 16 entries for this tutorial. You may insert this into your BMS: 
<code>00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF</code> 
 
Our BMS should now currently look like this: 
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000
</source>
You can also add an entire row of padding/zeros after this. You can do this for each section, to better visually separate them.
 

== Timing ruleset list ==
This is another sequence of offsets. These just point to the location of a "[[#Inserting_timetables|timetable]]", which will be located at the end of our BMS file. <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0005AB 0005AB 0005AF 0005C1 0005AB 0005AB 0005C1 0005C1 0005C1 0005C1 FFFFFF</code> 
Timing ruleset "0" will use the timetable at <code>0x5AB</code>, timing ruleset "1" will also use the timetable at <code>0x5AB</code>, timing ruleset "2" will use the timetable at <code>0x5AF</code>, and so on. There are a total of 10 timing rulesets listed in the above sequence.
 
Let's use <code>00BBBB</code> as placeholders again, and create 16 of them. Insert this anywhere into your BMS: 
<code>00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB FFFFFF</code> 
 

== Gesture set contents ==
A ''gesture set'' is a group of many gestures. 
Here, we list each gesture set's contents (which are... the locations of gestures!). Each gesture set begins before the <code>00</code> and ends with <code>FFFFFF</code>. 
Here is an example of how the gesture set list should be formatted: 
<code>000210 00022A 000258 000281 FFFFFF 0002B4 0002D9 000303 000331 FFFFFF 000355 FFFFFF 000361 FFFFFF 0003A8 0003C2 0003F0 000419 FFFFFF 00044C 000471 00049B 0004C9 FFFFFF 0004ED FFFFFF 000543 FFFFFF 000580 FFFFFF 00059E FFFFFF</code> 
There are 10 gesture sets listed above. The first gesture set has 4 gestures, located at <code>0x210</code>, <code>0x22A</code>, <code>0x258</code>, and <code>0x281</code>. You can have any amount of gestures in a gesture set; even 1 is fine.
 
You can paste the following placeholder information for now: 
<code>00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC FFFFFF</code> 
It might be a good idea to leave a decent amount of zeros after this list; this one will expand a lot as gestures and gesture sets are added to it.
 

== How is your BMS looking? ==
If you have been copy-pasting everything correctly, your BMS will look something like this:
<gallery mode="packed-hover" widths=300px heights=300px>
File:BMS_file_progress_1.png|Orange is "gesture set list", green is "timing ruleset list", and blue is "gesture set contents"
</gallery>
Once again, you can add as much padding between each section as you want, it will work fine.
== Creating gestures ==
First, you should sketch out your song idea in your DAW, and then cut your song into tiny blocks. These blocks will be your song's individual gestures. You should also consider dragging these blocks around in various arrangements to make sure they sound good in any order. 
Once you are ready, have them nicely organized and ready to be exported into individual MIDI files:
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_Pro_gestures.png|A Logic Pro project with a bunch of short blocks of music. Each block will be a "gesture".
</gallery>
For some reason, imported BMS files play 4 times as slow in cave songs. So if you import these gestures as is, they will play 4 times as slow. 
Before you export your gestures, you need to modify your gestures to run ''4 times as fast''. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each block.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>

== Inserting gestures ==
Gestures use same the note/music information as standard BMS songs. 

You should have converted all your MIDIs into BMS files. Open up one of your converted BMS files, and look for the first note/pitch value. If you used [[Pikmin 2 custom music|flaaffy]], this will most likely be somewhere after <code>0x1B</code>, <code>0x1C</code>, or <code>0x1D</code>. The note's pitch value will be followed by a <code>01</code>. Copy this note, all the way to the end of the sequence, which should be <code>FF</code>.
<gallery mode="packed-hover" widths=600px>
File:Copy_pasting_BMS_info.png|The value "2D" here is the hex value of a certain pitch, and the very first note of the sequence. Copy this, all the way to "FF".
</gallery>
To add your gesture, start it with <code>C40000015D</code>, then paste in what you copied. Each gesture should end with that <code>FF</code>. Add as many gestures as you please!
<gallery mode="packed-hover" widths=400px heights=400px>
File:BMS_file_progress_2.png|The purple lines indicate where a gesture starts.
</gallery>

== Inserting timetables ==
So, how do we choose how often gestures will play? Will a gesture play every beat? Every 1/2 a beat? You will need to add a timetable for that!
A timetable is a sequence that dictates when gestures should play. A timetable ends with <code>FFFF</code>. You can make a timetable as complex as you like. Some examples of timetables you can use are: 
* <code>0780FFFF</code> Play a gesture every 16 beats. 
* <code>03C0FFFF</code> Play a gesture every 8 beats. 
* <code>01E0FFFF</code> Play a gesture every 4 beats. 
* <code>03C003C003C001E001E001E001E003C0FFFF</code> This sequence will play a gesture every 8 beats (3x), play a gesture every 4 beats (4x), then play a gesture for 8 beats (1x), in that order. 
* <code>00F0FFFF</code> Play a gesture every 1/2 note (every 2 beats). 
* <code>0078FFFF</code> Play a gesture every 1/4 note (every beat). 
* <code>003CFFFF</code> Play a gesture every 1/8th note. 
* <code>001EFFFF</code> Play a gesture every 1/16th note. 
* <code>003C0078001EFFFF</code> This sequence will play a gesture for an 1/8th note, play a gesture for a 1/4 note, then play a gesture for a 1/16th note, in that order. 
Considering that <code>001E</code> (30 in decimal) is a 1/16th note, you can create any specific timing you want. Just add another 30 to the value for each additional sixteenth note in length. 
For example, Soil 1's enemy mix piano plays very rapidly; its timetable uses a value of 90, which looks like <code>005AFFFF</code>. The gestures last for three sixteenth notes. 
You can insert your timetables anywhere at the end of your BMS.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_3.png|Each timetable has a pink box around it.
</gallery>

== Filling in info ==
Once you have your gestures and timetables inserted, go back and fill in those <code>00AAAA</code>, <code>00BBBB</code>, <code>00CCCC</code> placeholders with the locations of your gesture sets, timetables, and gestures you want to use. Remember that gesture sets begin with the <code>00</code>.

Also in the very beginning of your BMS, make sure the value at <code>0x6</code> has the location of where your gesture set list begins (this one will probably be fine), and the value at <code>0x14</code> has the location of where your timing ruleset list begins.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_4.png|Put the location of where the "timing ruleset list" begins here.
</gallery>

== Filling in the conductor file ==
<gallery mode="packed-hover" widths=500px heights=500px>
File:CND_functions.png|Conductor file functions.
</gallery>
In your song's associated conductor file, try to stretch out the window so that the instrument names are all in the same column if you can, like in the image above. 
Each line represents one track. You give each track a instrument (program), and what gesture set and timing ruleset to use. 
The CND infographic above does a good job explaining all the functions, but they'll be explained again down here. 

In the top left corner are three important values:
* The first value is the swing time. <code>1E</code> is 1/16th swing, while <code>3C</code> is 1/8th swing. If your song is below 100bpm, you might want to use <code>1E</code>. If its faster, try <code>3C</code> instead.
* The second value is the tempo, in hex.
* The third value is how many tracks there will be, in hex.

Each column explained:
* A: Initial delay. How many beats until this track starts running. In the vanilla game, you can notice how some song's melodies do not immediately begin playing upon the start of level. This is useful for that; ease the listener into the music.
* B/Q: If set to 1, all gestures will be delayed by an 1/8th note..
* C: Text string. You can make this say whatever you like. Useful for keeping track of what you want each track to be, like "Lead", "Trumpet", "MelodyA"/"MelodyB", "Bass", or "Drums"
* D: Track copy. Select a previous track # to copy the gestures from. If the track its copying plays "gesture 3" from its gesture set, this track will also play its "gesture 3". Often used for treasure mix instruments. You can have them use different gesture sets if you like.
* E: Echo strength.
* F: If set to 1, the values in this track's timetable will always be played in order, in a loop. If set to 0, it will randomly select values from its timetable, thus, allowing you to randomize when gestures play.
* G: Bank number.
* H: Program number. For a list of all programs in the default game and the wScenes that support them, view [[Pikmin 2 custom_music/available instruments|this page]].
* I: Gesture set, select the set # you want to use from the BMS.
* J: Timing ruleset, select the set # you want to use from the BMS.
* K: How many gestures this track will play, before playing "silent gestures". Linked to below. These function as a sort of on/off cycle.
* L: How many "silent gestures" this track will play, before playing normal gestures. Linked to above. These function as a sort of on/off cycle.
* M: If notes are being transposed down (see below), this is set to FF. But this column doesn't actually do anything, so you don't need to edit this.
* N: Transpose all notes played by this track. To transpose up, use values 1-127. To transpose down, use the sign 2 compliment (values 128-255).
* O: Volume.
* P: Stereo panning.
 
Some considerations:
* You can use the on/off cycle feature (column K and L) to make your melodic instrument "take a break" every once in a while. You can have it play 4 gestures, but then be silent for 2.
* If your timing ruleset is strict (as in, the timings for when gestures occur is always consistent), something fun to try is to have the melody be a back-and-forth between two different instruments. Set the initial delay for the second instrument to be longer than the first one, and then cleverly use the on/off cycle to have the instruments take turns sounding a gesture. This is done for the melody in the Bulblax Kingdom and Frontier Cavern for example.
* If you are using the "track copy" feature (column D), you can have the primary instrument play a melody, and have this instrument always play chords that perfectly match that melody.
* The 1/8th note delay achieved with column Q and the "track copy" feature can be used to create a stereo echo effect; make the copying track quieter and panned to a different speaker! It works better the faster your song is.

== Mapping the tracks ==
With all that done, don't forget to edit the song's [[Trackmap parameters|trackMap]]! Edit your song in the trackMap files in either <code>/user/Totaka</code> or <code>/user/Wakai</code>, and set how many instruments will be in each mix. It goes in order from: Main Mix, Task (event), Treasure (otakara), Enemy near (kehai), Combat mix, and Spiderwort mix (ground). Although you cannot find Spiderworts underground, you will have to sacrifice at least one track for that mix. You cannot set any of the mixes to have 0 instruments in them.

== Bonus: Filenames for brand new CND files ==
If you are adding a brand new CND file instead of replacing an existing one, the prefix will determine which BMS is loaded, and which wScene. Try not to add special characters to filenames, aside from underscores. 

In order to load the correct BMS file, the CND must start with the name of the BMS file.
* "caveconc.cnd", "caveconc_458435.cnd", "caveconc_Waffles.cnd", and "caveconc_Waffles_Song_2.cnd" will all load caveconc.bms. 
* "caverelax.cnd", "caverelax_Gmajor.cnd", and "caverelax_mamuta_dinner.cnd" will all load caverelax.bms. 
* "new_09_4.cnd", "new_09_4000.cnd", and "new_09_portal_PotaTOS.cnd" will load new_09.bms. 

For cavesoil, caveconc, and cavemetal only, the game also checks for an additional "_00", "_05", and "_10" right after the prefix, for the purpose of loading one of three different wScenes. You must include it if you want the correct wScene to load. For example, caveconc_05 loads wScene 31, so if you want your custom song to also load wScene 31, acceptable names include "caveconc_05_WAFFLES.cnd", "caveconc_05_52_46356.cnd", or "caveconc_05_super_boss.cnd". 

After adding your new CND file, be sure to add it to its respective trackMap file.

== Bonus: Adding new content to a vanilla BMS file ==
Adding new hex data in the middle of a file will shift all the offsets that come after it, causing your BMS to jump to the wrong locations, and likely cause a crash if vanilla songs are loaded. 
In order to add new content in addition to what's already in the BMS:
* Find and copy the gesture set list and the timing ruleset list, and paste them at the end of the file. (Separate them with lots of zeros so you have lots more space to add content to these lists)
* Change <code>0x6</code> and <code>0x14</code> to point to your new gesture set list and timing ruleset list. These two values tell the game where the lists are.
The game should now use these brand new lists, instead of the original instances that occur earlier in the file. Since they still contain all the locations of the vanilla gesture sets/timetables from above in the same order, the existing CND songs won't be affected and will continue to function, but now you can expand upon these lists with brand new entries now that you've made the space for them. All new gestures, gesture sets and timetables can be added further down the file.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Editing_vanilla_BMS_file.png|The new gesture set list and timing ruleset list we want to use will be at the bottom.
</gallery>

[[Category:Pikmin 2]]

Creating cave music

2024-03-11T18:07:15Z

Waffles: /* Bonus: Filenames for brand new CND files */

Randomly generating cave music in Pikmin 2 needs to have two files: a .bms (sequence) file, and a .cnd (conductor) file.

The BMS file type is a sequenced music format used in many games. For the cave music in Pikmin 2 however, it is specially-formatted. It mainly contains many short snippets of musical information to be randomized.

The CND files are the actual "songs"; they take specific groups of snippets from a BMS file, and endlessly puzzle-piece them together to form a coherent piece of music.

This guide will function as a walkthrough for creating your own randomly sequencing cave song. All of the editing will be done in hexadecimal.

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be generating a lot of tiny BMS files, to turn them into "gestures".
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

== Overview of file functions ==
Here are some infographics that you can reference at any time. These show all the functions of a CND file, and all the contents of a BMS file.
<gallery mode="packed-hover" widths=250px heights=250px>
File:CND_functions.png|Conductor file functions.
File:BMS_functions.png|How information is stored in a BMS file.
</gallery>

== Setting up your BMS file ==
Before you begin, set your byte grouping to "3", so every 3 bytes is visually separated by a space. This will make it easier to see stuff. 
Starting with a completely blank BMS file, begin by pasting the following:
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600
</source>
Every cave music BMS begins with this same information.
 
 
== Gesture set list ==
Exactly right after <code>34C600</code> will be a list of every gesture set's location in the BMS. Each entry is the gesture set's hexadecimal location (offset), and each entry in the sequence begins with "<code>00</code>". <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0001B0 0001BF 0001CE 0001D4 0001DA 0001E9 0001F8 0001FE 000204 00020A FFFFFF</code> 
Gesture set "0" will be at offset <code>0x1B0</code>, gesture set "1" will be at offset <code>0x1BF</code>, gesture set "2" will be at <code>0x1CE</code>, and so on. There are a total of 10 gesture sets listed in the above sequence.
 
Until we create our gesture sets, let's use <code>00AAAA</code> as placeholders so we can easily find and get back to this section later on. You can have as many gesture sets as you like; we'll create 16 entries for this tutorial. You may insert this into your BMS: 
<code>00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF</code> 
 
Our BMS should now currently look like this: 
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000
</source>
You can also add an entire row of padding/zeros after this. You can do this for each section, to better visually separate them.
 

== Timing ruleset list ==
This is another sequence of offsets. These just point to the location of a "[[#Inserting_timetables|timetable]]", which will be located at the end of our BMS file. <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0005AB 0005AB 0005AF 0005C1 0005AB 0005AB 0005C1 0005C1 0005C1 0005C1 FFFFFF</code> 
Timing ruleset "0" will use the timetable at <code>0x5AB</code>, timing ruleset "1" will also use the timetable at <code>0x5AB</code>, timing ruleset "2" will use the timetable at <code>0x5AF</code>, and so on. There are a total of 10 timing rulesets listed in the above sequence.
 
Let's use <code>00BBBB</code> as placeholders again, and create 16 of them. Insert this anywhere into your BMS: 
<code>00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB FFFFFF</code> 
 

== Gesture set contents ==
A ''gesture set'' is a group of many gestures. 
Here, we list each gesture set's contents (which are... the locations of gestures!). Each gesture set begins before the <code>00</code> and ends with <code>FFFFFF</code>. 
Here is an example of how the gesture set list should be formatted: 
<code>000210 00022A 000258 000281 FFFFFF 0002B4 0002D9 000303 000331 FFFFFF 000355 FFFFFF 000361 FFFFFF 0003A8 0003C2 0003F0 000419 FFFFFF 00044C 000471 00049B 0004C9 FFFFFF 0004ED FFFFFF 000543 FFFFFF 000580 FFFFFF 00059E FFFFFF</code> 
There are 10 gesture sets listed above. The first gesture set has 4 gestures, located at <code>0x210</code>, <code>0x22A</code>, <code>0x258</code>, and <code>0x281</code>. You can have any amount of gestures in a gesture set; even 1 is fine.
 
You can paste the following placeholder information for now: 
<code>00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC FFFFFF</code> 
It might be a good idea to leave a decent amount of zeros after this list; this one will expand a lot as gestures and gesture sets are added to it.
 

== How is your BMS looking? ==
If you have been copy-pasting everything correctly, your BMS will look something like this:
<gallery mode="packed-hover" widths=300px heights=300px>
File:BMS_file_progress_1.png|Orange is "gesture set list", green is "timing ruleset list", and blue is "gesture set contents"
</gallery>
Once again, you can add as much padding between each section as you want, it will work fine.
== Creating gestures ==
First, you should sketch out your song idea in your DAW, and then cut your song into tiny blocks. These blocks will be your song's individual gestures. You should also consider dragging these blocks around in various arrangements to make sure they sound good in any order. 
Once you are ready, have them nicely organized and ready to be exported into individual MIDI files:
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_Pro_gestures.png|A Logic Pro project with a bunch of short blocks of music. Each block will be a "gesture".
</gallery>
For some reason, imported BMS files play 4 times as slow in cave songs. So if you import these gestures as is, they will play 4 times as slow. 
Before you export your gestures, you need to modify your gestures to run ''4 times as fast''. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each block.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>

== Inserting gestures ==
Gestures use same the note/music information as standard BMS songs. 

You should have converted all your MIDIs into BMS files. Open up one of your converted BMS files, and look for the first note/pitch value. If you used [[Pikmin 2 custom music|flaaffy]], this will most likely be somewhere after <code>0x1B</code>, <code>0x1C</code>, or <code>0x1D</code>. The note's pitch value will be followed by a <code>01</code>. Copy this note, all the way to the end of the sequence, which should be <code>FF</code>.
<gallery mode="packed-hover" widths=600px>
File:Copy_pasting_BMS_info.png|The value "2D" here is the hex value of a certain pitch, and the very first note of the sequence. Copy this, all the way to "FF".
</gallery>
To add your gesture, start it with <code>C40000015D</code>, then paste in what you copied. Each gesture should end with that <code>FF</code>. Add as many gestures as you please!
<gallery mode="packed-hover" widths=400px heights=400px>
File:BMS_file_progress_2.png|The purple lines indicate where a gesture starts.
</gallery>

== Inserting timetables ==
So, how do we choose how often gestures will play? Will a gesture play every beat? Every 1/2 a beat? You will need to add a timetable for that!
A timetable is a sequence that dictates when gestures should play. A timetable ends with <code>FFFF</code>. You can make a timetable as complex as you like. Some examples of timetables you can use are: 
* <code>0780FFFF</code> Play a gesture every 16 beats. 
* <code>03C0FFFF</code> Play a gesture every 8 beats. 
* <code>01E0FFFF</code> Play a gesture every 4 beats. 
* <code>03C003C003C001E001E001E001E003C0FFFF</code> This sequence will play a gesture every 8 beats (3x), play a gesture every 4 beats (4x), then play a gesture for 8 beats (1x), in that order. 
* <code>00F0FFFF</code> Play a gesture every 1/2 note (every 2 beats). 
* <code>0078FFFF</code> Play a gesture every 1/4 note (every beat). 
* <code>003CFFFF</code> Play a gesture every 1/8th note. 
* <code>001EFFFF</code> Play a gesture every 1/16th note. 
* <code>003C0078001EFFFF</code> This sequence will play a gesture for an 1/8th note, play a gesture for a 1/4 note, then play a gesture for a 1/16th note, in that order. 
Considering that <code>001E</code> (30 in decimal) is a 1/16th note, you can create any specific timing you want. Just add another 30 to the value for each additional sixteenth note in length. 
For example, Soil 1's enemy mix piano plays very rapidly; its timetable uses a value of 90, which looks like <code>005AFFFF</code>. The gestures last for three sixteenth notes. 
You can insert your timetables anywhere at the end of your BMS.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_3.png|Each timetable has a pink box around it.
</gallery>

== Filling in info ==
Once you have your gestures and timetables inserted, go back and fill in those <code>00AAAA</code>, <code>00BBBB</code>, <code>00CCCC</code> placeholders with the locations of your gesture sets, timetables, and gestures you want to use. Remember that gesture sets begin with the <code>00</code>.

Also in the very beginning of your BMS, make sure the value at <code>0x6</code> has the location of where your gesture set list begins (this one will probably be fine), and the value at <code>0x14</code> has the location of where your timing ruleset list begins.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_4.png|Put the location of where the "timing ruleset list" begins here.
</gallery>

== Filling in the conductor file ==
<gallery mode="packed-hover" widths=500px heights=500px>
File:CND_functions.png|Conductor file functions.
</gallery>
In your song's associated conductor file, try to stretch out the window so that the instrument names are all in the same column if you can, like in the image above. 
Each line represents one track. You give each track a instrument (program), and what gesture set and timing ruleset to use. 
The CND infographic above does a good job explaining all the functions, but they'll be explained again down here. 

In the top left corner are three important values:
* The first value is the swing time. <code>1E</code> is 1/16th swing, while <code>3C</code> is 1/8th swing. If your song is below 100bpm, you might want to use <code>1E</code>. If its faster, try <code>3C</code> instead.
* The second value is the tempo, in hex.
* The third value is how many tracks there will be, in hex.

Each column explained:
* A: Initial delay. How many beats until this track starts running. In the vanilla game, you can notice how some song's melodies do not immediately begin playing upon the start of level. This is useful for that; ease the listener into the music.
* B/Q: If set to 1, all gestures will be delayed by an 1/8th note..
* C: Text string. You can make this say whatever you like. Useful for keeping track of what you want each track to be, like "Lead", "Trumpet", "MelodyA"/"MelodyB", "Bass", or "Drums"
* D: Track copy. Select a previous track # to copy the gestures from. If the track its copying plays "gesture 3" from its gesture set, this track will also play its "gesture 3". Often used for treasure mix instruments. You can have them use different gesture sets if you like.
* E: Echo strength.
* F: If set to 1, the values in this track's timetable will always be played in order, in a loop. If set to 0, it will randomly select values from its timetable, thus, allowing you to randomize when gestures play.
* G: Bank number.
* H: Program number. For a list of all programs in the default game and the wScenes that support them, view [[Pikmin 2 custom_music/available instruments|this page]].
* I: Gesture set, select the set # you want to use from the BMS.
* J: Timing ruleset, select the set # you want to use from the BMS.
* K: How many gestures this track will play, before playing "silent gestures". Linked to below. These function as a sort of on/off cycle.
* L: How many "silent gestures" this track will play, before playing normal gestures. Linked to above. These function as a sort of on/off cycle.
* M: If notes are being transposed down (see below), this is set to FF. But this column doesn't actually do anything, so you don't need to edit this.
* N: Transpose all notes played by this track. To transpose up, use values 1-127. To transpose down, use the sign 2 compliment (values 128-255).
* O: Volume.
* P: Stereo panning.
 
Some considerations:
* You can use the on/off cycle feature (column K and L) to make your melodic instrument "take a break" every once in a while. You can have it play 4 gestures, but then be silent for 2.
* If your timing ruleset is strict (as in, the timings for when gestures occur is always consistent), something fun to try is to have the melody be a back-and-forth between two different instruments. Set the initial delay for the second instrument to be longer than the first one, and then cleverly use the on/off cycle to have the instruments take turns sounding a gesture. This is done for the melody in the Bulblax Kingdom and Frontier Cavern for example.
* If you are using the "track copy" feature (column D), you can have the primary instrument play a melody, and have this instrument always play chords that perfectly match that melody.
* The 1/8th note delay achieved with column Q and the "track copy" feature can be used to create a stereo echo effect; make the copying track quieter and panned to a different speaker! It works better the faster your song is.

== Mapping the tracks ==
With all that done, don't forget to edit the song's [[Trackmap parameters|trackMap]]! Edit your song in the trackMap files in either <code>/user/Totaka</code> or <code>/user/Wakai</code>, and set how many instruments will be in each mix. It goes in order from: Main Mix, Task (event), Treasure (otakara), Enemy near (kehai), Combat mix, and Spiderwort mix (ground). Although you cannot find Spiderworts underground, you will have to sacrifice at least one track for that mix. You cannot set any of the mixes to have 0 instruments in them.

== Bonus: Filenames for brand new CND files ==
If you are adding a brand new CND file instead of replacing an existing one, the prefix will determine which BMS is loaded, and which wScene. Try not to add special characters to filenames, aside from underscores. 

In order to load the correct BMS file, the CND must start with the name of the BMS file.
* "caveconc.cnd", "caveconc_458435.cnd", "caveconc_Waffles.cnd", and "caveconc_Waffles_Song_2.cnd" will all load caveconc.bms. 
* "caverelax.cnd", "caverelax_Gmajor.cnd", and "caverelax_mamuta_dinner.cnd" will all load caverelax.bms. 
* "new_09_4.cnd", "new_09_4000.cnd", and "new_09_portal_PotaTOS.cnd" will load new_09.bms. 

For cavesoil, caveconc, and cavemetal only, the game also checks for an additional "_00", "_05", and "_10" right after the prefix, for the purpose of loading one of three different wScenes. You must include it if you want the correct wScene to load. For example, caveconc_05 loads wScene 31, so if you want your custom song to also load wScene 31, acceptable names include "caveconc_05_WAFFLES.cnd", "caveconc_05_52_46356.cnd", or "caveconc_05_super_boss.cnd". 

After adding your new CND file, be sure to add it to its respective trackMap file.

== Bonus: Adding new content to a vanilla BMS file ==
Adding new hex data in the middle of a file will shift all the offsets that come after it, causing your BMS to jump to the wrong locations, and likely cause a crash if vanilla songs are loaded. 
In order to add new content in addition to what's already in the BMS, you can copy and put a brand new gesture set list and timing ruleset list at the bottom:
* Find and copy the gesture set list and the timing ruleset list, and paste them at the end of the file. (Separate them with lots of zeros so you have lots more space to add content to these lists)
* Change <code>0x6</code> and <code>0x14</code> to point to your new gesture set list and timing ruleset list. These two values tell the game where the lists are.
The game should now use these brand new lists, instead of the original instances that occur earlier in the file. Since they still contain all the locations of the vanilla gesture sets/timetables from above in the same order, the existing CND songs won't be affected and will continue to function, but now you can expand upon these lists with brand new entries now that you've made the space for them. All new gestures, gesture sets and timetables can be added further down the file.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Editing_vanilla_BMS_file.png|The new gesture set list and timing ruleset list we want to use will be at the bottom.
</gallery>

[[Category:Pikmin 2]]

Creating cave music

2024-03-11T18:00:28Z

Waffles:

Randomly generating cave music in Pikmin 2 needs to have two files: a .bms (sequence) file, and a .cnd (conductor) file.

The BMS file type is a sequenced music format used in many games. For the cave music in Pikmin 2 however, it is specially-formatted. It mainly contains many short snippets of musical information to be randomized.

The CND files are the actual "songs"; they take specific groups of snippets from a BMS file, and endlessly puzzle-piece them together to form a coherent piece of music.

This guide will function as a walkthrough for creating your own randomly sequencing cave song. All of the editing will be done in hexadecimal.

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be generating a lot of tiny BMS files, to turn them into "gestures".
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

== Overview of file functions ==
Here are some infographics that you can reference at any time. These show all the functions of a CND file, and all the contents of a BMS file.
<gallery mode="packed-hover" widths=250px heights=250px>
File:CND_functions.png|Conductor file functions.
File:BMS_functions.png|How information is stored in a BMS file.
</gallery>

== Setting up your BMS file ==
Before you begin, set your byte grouping to "3", so every 3 bytes is visually separated by a space. This will make it easier to see stuff. 
Starting with a completely blank BMS file, begin by pasting the following:
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600
</source>
Every cave music BMS begins with this same information.
 
 
== Gesture set list ==
Exactly right after <code>34C600</code> will be a list of every gesture set's location in the BMS. Each entry is the gesture set's hexadecimal location (offset), and each entry in the sequence begins with "<code>00</code>". <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0001B0 0001BF 0001CE 0001D4 0001DA 0001E9 0001F8 0001FE 000204 00020A FFFFFF</code> 
Gesture set "0" will be at offset <code>0x1B0</code>, gesture set "1" will be at offset <code>0x1BF</code>, gesture set "2" will be at <code>0x1CE</code>, and so on. There are a total of 10 gesture sets listed in the above sequence.
 
Until we create our gesture sets, let's use <code>00AAAA</code> as placeholders so we can easily find and get back to this section later on. You can have as many gesture sets as you like; we'll create 16 entries for this tutorial. You may insert this into your BMS: 
<code>00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF</code> 
 
Our BMS should now currently look like this: 
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000
</source>
You can also add an entire row of padding/zeros after this. You can do this for each section, to better visually separate them.
 

== Timing ruleset list ==
This is another sequence of offsets. These just point to the location of a "[[#Inserting_timetables|timetable]]", which will be located at the end of our BMS file. <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0005AB 0005AB 0005AF 0005C1 0005AB 0005AB 0005C1 0005C1 0005C1 0005C1 FFFFFF</code> 
Timing ruleset "0" will use the timetable at <code>0x5AB</code>, timing ruleset "1" will also use the timetable at <code>0x5AB</code>, timing ruleset "2" will use the timetable at <code>0x5AF</code>, and so on. There are a total of 10 timing rulesets listed in the above sequence.
 
Let's use <code>00BBBB</code> as placeholders again, and create 16 of them. Insert this anywhere into your BMS: 
<code>00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB FFFFFF</code> 
 

== Gesture set contents ==
A ''gesture set'' is a group of many gestures. 
Here, we list each gesture set's contents (which are... the locations of gestures!). Each gesture set begins before the <code>00</code> and ends with <code>FFFFFF</code>. 
Here is an example of how the gesture set list should be formatted: 
<code>000210 00022A 000258 000281 FFFFFF 0002B4 0002D9 000303 000331 FFFFFF 000355 FFFFFF 000361 FFFFFF 0003A8 0003C2 0003F0 000419 FFFFFF 00044C 000471 00049B 0004C9 FFFFFF 0004ED FFFFFF 000543 FFFFFF 000580 FFFFFF 00059E FFFFFF</code> 
There are 10 gesture sets listed above. The first gesture set has 4 gestures, located at <code>0x210</code>, <code>0x22A</code>, <code>0x258</code>, and <code>0x281</code>. You can have any amount of gestures in a gesture set; even 1 is fine.
 
You can paste the following placeholder information for now: 
<code>00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC FFFFFF</code> 
It might be a good idea to leave a decent amount of zeros after this list; this one will expand a lot as gestures and gesture sets are added to it.
 

== How is your BMS looking? ==
If you have been copy-pasting everything correctly, your BMS will look something like this:
<gallery mode="packed-hover" widths=300px heights=300px>
File:BMS_file_progress_1.png|Orange is "gesture set list", green is "timing ruleset list", and blue is "gesture set contents"
</gallery>
Once again, you can add as much padding between each section as you want, it will work fine.
== Creating gestures ==
First, you should sketch out your song idea in your DAW, and then cut your song into tiny blocks. These blocks will be your song's individual gestures. You should also consider dragging these blocks around in various arrangements to make sure they sound good in any order. 
Once you are ready, have them nicely organized and ready to be exported into individual MIDI files:
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_Pro_gestures.png|A Logic Pro project with a bunch of short blocks of music. Each block will be a "gesture".
</gallery>
For some reason, imported BMS files play 4 times as slow in cave songs. So if you import these gestures as is, they will play 4 times as slow. 
Before you export your gestures, you need to modify your gestures to run ''4 times as fast''. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each block.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>

== Inserting gestures ==
Gestures use same the note/music information as standard BMS songs. 

You should have converted all your MIDIs into BMS files. Open up one of your converted BMS files, and look for the first note/pitch value. If you used [[Pikmin 2 custom music|flaaffy]], this will most likely be somewhere after <code>0x1B</code>, <code>0x1C</code>, or <code>0x1D</code>. The note's pitch value will be followed by a <code>01</code>. Copy this note, all the way to the end of the sequence, which should be <code>FF</code>.
<gallery mode="packed-hover" widths=600px>
File:Copy_pasting_BMS_info.png|The value "2D" here is the hex value of a certain pitch, and the very first note of the sequence. Copy this, all the way to "FF".
</gallery>
To add your gesture, start it with <code>C40000015D</code>, then paste in what you copied. Each gesture should end with that <code>FF</code>. Add as many gestures as you please!
<gallery mode="packed-hover" widths=400px heights=400px>
File:BMS_file_progress_2.png|The purple lines indicate where a gesture starts.
</gallery>

== Inserting timetables ==
So, how do we choose how often gestures will play? Will a gesture play every beat? Every 1/2 a beat? You will need to add a timetable for that!
A timetable is a sequence that dictates when gestures should play. A timetable ends with <code>FFFF</code>. You can make a timetable as complex as you like. Some examples of timetables you can use are: 
* <code>0780FFFF</code> Play a gesture every 16 beats. 
* <code>03C0FFFF</code> Play a gesture every 8 beats. 
* <code>01E0FFFF</code> Play a gesture every 4 beats. 
* <code>03C003C003C001E001E001E001E003C0FFFF</code> This sequence will play a gesture every 8 beats (3x), play a gesture every 4 beats (4x), then play a gesture for 8 beats (1x), in that order. 
* <code>00F0FFFF</code> Play a gesture every 1/2 note (every 2 beats). 
* <code>0078FFFF</code> Play a gesture every 1/4 note (every beat). 
* <code>003CFFFF</code> Play a gesture every 1/8th note. 
* <code>001EFFFF</code> Play a gesture every 1/16th note. 
* <code>003C0078001EFFFF</code> This sequence will play a gesture for an 1/8th note, play a gesture for a 1/4 note, then play a gesture for a 1/16th note, in that order. 
Considering that <code>001E</code> (30 in decimal) is a 1/16th note, you can create any specific timing you want. Just add another 30 to the value for each additional sixteenth note in length. 
For example, Soil 1's enemy mix piano plays very rapidly; its timetable uses a value of 90, which looks like <code>005AFFFF</code>. The gestures last for three sixteenth notes. 
You can insert your timetables anywhere at the end of your BMS.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_3.png|Each timetable has a pink box around it.
</gallery>

== Filling in info ==
Once you have your gestures and timetables inserted, go back and fill in those <code>00AAAA</code>, <code>00BBBB</code>, <code>00CCCC</code> placeholders with the locations of your gesture sets, timetables, and gestures you want to use. Remember that gesture sets begin with the <code>00</code>.

Also in the very beginning of your BMS, make sure the value at <code>0x6</code> has the location of where your gesture set list begins (this one will probably be fine), and the value at <code>0x14</code> has the location of where your timing ruleset list begins.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_4.png|Put the location of where the "timing ruleset list" begins here.
</gallery>

== Filling in the conductor file ==
<gallery mode="packed-hover" widths=500px heights=500px>
File:CND_functions.png|Conductor file functions.
</gallery>
In your song's associated conductor file, try to stretch out the window so that the instrument names are all in the same column if you can, like in the image above. 
Each line represents one track. You give each track a instrument (program), and what gesture set and timing ruleset to use. 
The CND infographic above does a good job explaining all the functions, but they'll be explained again down here. 

In the top left corner are three important values:
* The first value is the swing time. <code>1E</code> is 1/16th swing, while <code>3C</code> is 1/8th swing. If your song is below 100bpm, you might want to use <code>1E</code>. If its faster, try <code>3C</code> instead.
* The second value is the tempo, in hex.
* The third value is how many tracks there will be, in hex.

Each column explained:
* A: Initial delay. How many beats until this track starts running. In the vanilla game, you can notice how some song's melodies do not immediately begin playing upon the start of level. This is useful for that; ease the listener into the music.
* B/Q: If set to 1, all gestures will be delayed by an 1/8th note..
* C: Text string. You can make this say whatever you like. Useful for keeping track of what you want each track to be, like "Lead", "Trumpet", "MelodyA"/"MelodyB", "Bass", or "Drums"
* D: Track copy. Select a previous track # to copy the gestures from. If the track its copying plays "gesture 3" from its gesture set, this track will also play its "gesture 3". Often used for treasure mix instruments. You can have them use different gesture sets if you like.
* E: Echo strength.
* F: If set to 1, the values in this track's timetable will always be played in order, in a loop. If set to 0, it will randomly select values from its timetable, thus, allowing you to randomize when gestures play.
* G: Bank number.
* H: Program number. For a list of all programs in the default game and the wScenes that support them, view [[Pikmin 2 custom_music/available instruments|this page]].
* I: Gesture set, select the set # you want to use from the BMS.
* J: Timing ruleset, select the set # you want to use from the BMS.
* K: How many gestures this track will play, before playing "silent gestures". Linked to below. These function as a sort of on/off cycle.
* L: How many "silent gestures" this track will play, before playing normal gestures. Linked to above. These function as a sort of on/off cycle.
* M: If notes are being transposed down (see below), this is set to FF. But this column doesn't actually do anything, so you don't need to edit this.
* N: Transpose all notes played by this track. To transpose up, use values 1-127. To transpose down, use the sign 2 compliment (values 128-255).
* O: Volume.
* P: Stereo panning.
 
Some considerations:
* You can use the on/off cycle feature (column K and L) to make your melodic instrument "take a break" every once in a while. You can have it play 4 gestures, but then be silent for 2.
* If your timing ruleset is strict (as in, the timings for when gestures occur is always consistent), something fun to try is to have the melody be a back-and-forth between two different instruments. Set the initial delay for the second instrument to be longer than the first one, and then cleverly use the on/off cycle to have the instruments take turns sounding a gesture. This is done for the melody in the Bulblax Kingdom and Frontier Cavern for example.
* If you are using the "track copy" feature (column D), you can have the primary instrument play a melody, and have this instrument always play chords that perfectly match that melody.
* The 1/8th note delay achieved with column Q and the "track copy" feature can be used to create a stereo echo effect; make the copying track quieter and panned to a different speaker! It works better the faster your song is.

== Mapping the tracks ==
With all that done, don't forget to edit the song's [[Trackmap parameters|trackMap]]! Edit your song in the trackMap files in either <code>/user/Totaka</code> or <code>/user/Wakai</code>, and set how many instruments will be in each mix. It goes in order from: Main Mix, Task (event), Treasure (otakara), Enemy near (kehai), Combat mix, and Spiderwort mix (ground). Although you cannot find Spiderworts underground, you will have to sacrifice at least one track for that mix. You cannot set any of the mixes to have 0 instruments in them.

== Bonus: Filenames for brand new CND files ==
If you are adding a brand new CND file instead of replacing an existing one, the prefix will determine which BMS is loaded, and which wScene. Try not to add special characters to filenames, aside from underscores. 

In order to load the correct BMS file, the CND must start with the name of the BMS file.
* "caveconc.cnd", "caveconc_458435.cnd", "caveconc_Waffles.cnd", and "caveconc_Waffles_Song_2.cnd" will all load caveconc.bms. 
* "caverelax.cnd", "caverelax_Gmajor.cnd", and "caverelax_mamuta_dinner.cnd" will all load caverelax.bms. 
* "new_09_4.cnd", "new_09_4000.cnd", and "new_09_portal_PotaTOS.cnd" will load new_09.bms. 

For cavesoil, caveconc, and cavemetal only, the game checks for an additional "_00", "_05", and "_10" right after the prefix, so you must include this if you want the right wScene to load. For example, caveconc_05 loads wScene 31, so if you want your custom song to load wScene 31, acceptable names include "caveconc_05_WAFFLES.cnd", "caveconc_05_52_46356.cnd", or "caveconc_05_super_boss.cnd". 

After adding your new CND file, be sure to add it to its respective trackMap file.

== Bonus: Adding new content to a vanilla BMS file ==
Adding new hex data in the middle of a file will shift all the offsets that come after it, causing your BMS to jump to the wrong locations, and likely cause a crash if vanilla songs are loaded. 
In order to add new content in addition to what's already in the BMS, you can copy and put a brand new gesture set list and timing ruleset list at the bottom:
* Find and copy the gesture set list and the timing ruleset list, and paste them at the end of the file. (Separate them with lots of zeros so you have lots more space to add content to these lists)
* Change <code>0x6</code> and <code>0x14</code> to point to your new gesture set list and timing ruleset list. These two values tell the game where the lists are.
The game should now use these brand new lists, instead of the original instances that occur earlier in the file. Since they still contain all the locations of the vanilla gesture sets/timetables from above in the same order, the existing CND songs won't be affected and will continue to function, but now you can expand upon these lists with brand new entries now that you've made the space for them. All new gestures, gesture sets and timetables can be added further down the file.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Editing_vanilla_BMS_file.png|The new gesture set list and timing ruleset list we want to use will be at the bottom.
</gallery>

[[Category:Pikmin 2]]

File:BMS file progress 4.png

2024-03-11T17:52:40Z

Waffles: Waffles uploaded a new version of File:BMS file progress 4.png

== Summary ==
For the "Creating randomly sequencing cave music" page.

File:BMS file progress 3.png

2024-03-11T17:52:28Z

Waffles: Waffles uploaded a new version of File:BMS file progress 3.png

== Summary ==
For the "Creating randomly sequencing cave music" page.

File:BMS file progress 2.png

2024-03-11T17:52:17Z

Waffles: Waffles uploaded a new version of File:BMS file progress 2.png

== Summary ==
For the "Creating randomly sequencing cave music" page.

File:BMS file progress 1.png

2024-03-11T17:52:00Z

Waffles: Waffles uploaded a new version of File:BMS file progress 1.png

== Summary ==
For the "Creating randomly sequencing cave music" page.

Creating cave music

2024-03-11T17:42:46Z

Waffles: /* Bonus: Adding new content to a vanilla BMS file */

Randomly generating cave music in Pikmin 2 needs to have two files: a .bms (sequence) file, and a .cnd (conductor) file.

The BMS file type is a sequenced music format used in many games. For the cave music in Pikmin 2 however, it is specially-formatted. It mainly contains many short snippets of musical information to be randomized.

The CND files are the actual "songs"; they take specific groups of snippets from a BMS file, and endlessly puzzle-piece them together to form a coherent piece of music.

This guide will function as a walkthrough for creating your own randomly sequencing cave song. All of the editing will be done in hexadecimal.

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be generating a lot of tiny BMS files, to turn them into "gestures".
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

== Overview of file functions ==
Here are some infographics that you can reference at any time. These show all the functions of a CND file, and all the contents of a BMS file.
<gallery mode="packed-hover" widths=250px heights=250px>
File:CND_functions.png|Conductor file functions.
File:BMS_functions.png|How information is stored in a BMS file.
</gallery>

== Setting up your BMS file ==
Before you begin, set your byte grouping to "3", so every 3 bytes is visually separated by a space. This will make it easier to see stuff. 
Starting with a completely blank BMS file, begin by pasting the following:
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600
</source>
Every cave music BMS begins with this same information.
 
 
== Gesture set list ==
Exactly right after <code>34C600</code> will be a list of every gesture set's location in the BMS. Each entry is the gesture set's hexadecimal location (offset), and each entry in the sequence begins with "<code>00</code>". <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0001B0 0001BF 0001CE 0001D4 0001DA 0001E9 0001F8 0001FE 000204 00020A FFFFFF</code> 
Gesture set "0" will be at offset <code>0x1B0</code>, gesture set "1" will be at offset <code>0x1BF</code>, gesture set "2" will be at <code>0x1CE</code>, and so on. There are a total of 10 gesture sets listed in the above sequence.
 
Until we create our gesture sets, let's use <code>00AAAA</code> as placeholders so we can easily find and get back to this section later on. You can have as many gesture sets as you like; we'll create 16 entries for this tutorial. You may insert this into your BMS: 
<code>00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF</code> 
 
Our BMS should now currently look like this: 
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000
</source>
You can also add an entire row of padding/zeros after this. You can do this for each section, to better visually separate them.
 

== Timing ruleset list ==
This is another sequence of offsets. These just point to the location of a "[[#Inserting_timetables|timetable]]", which will be located at the end of our BMS file. <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0005AB 0005AB 0005AF 0005C1 0005AB 0005AB 0005C1 0005C1 0005C1 0005C1 FFFFFF</code> 
Timing ruleset "0" will use the timetable at <code>0x5AB</code>, timing ruleset "1" will also use the timetable at <code>0x5AB</code>, timing ruleset "2" will use the timetable at <code>0x5AF</code>, and so on. There are a total of 10 timing rulesets listed in the above sequence.
 
Let's use <code>00BBBB</code> as placeholders again, and create 16 of them. Insert this anywhere into your BMS: 
<code>00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB FFFFFF</code> 
 

== Gesture set contents ==
A ''gesture set'' is a group of many gestures. 
Here, we list each gesture set's contents (which are... the locations of gestures!). Each gesture set begins before the <code>00</code> and ends with <code>FFFFFF</code>. 
Here is an example of how the gesture set list should be formatted: 
<code>000210 00022A 000258 000281 FFFFFF 0002B4 0002D9 000303 000331 FFFFFF 000355 FFFFFF 000361 FFFFFF 0003A8 0003C2 0003F0 000419 FFFFFF 00044C 000471 00049B 0004C9 FFFFFF 0004ED FFFFFF 000543 FFFFFF 000580 FFFFFF 00059E FFFFFF</code> 
There are 10 gesture sets listed above. The first gesture set has 4 gestures, located at <code>0x210</code>, <code>0x22A</code>, <code>0x258</code>, and <code>0x281</code>. You can have any amount of gestures in a gesture set; even 1 is fine.
 
You can paste the following placeholder information for now: 
<code>00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC FFFFFF</code> 
It might be a good idea to leave a decent amount of zeros after this list; this one will expand a lot as gestures and gesture sets are added to it.
 

== How is your BMS looking? ==
If you have been copy-pasting everything correctly, your BMS will look something like this:
<gallery mode="packed-hover" widths=300px heights=300px>
File:BMS_file_progress_1.png|Orange is "gesture set list", green is "timing ruleset list", and blue is "gesture set contents"
</gallery>
Once again, you can add as much padding between each section as you want, it will work fine.
== Creating gestures ==
First, you should sketch out your song idea in your DAW, and then cut your song into tiny blocks. These blocks will be your song's individual gestures. You should also consider dragging these blocks around in various arrangements to make sure they sound good in any order. 
Once you are ready, have them nicely organized and ready to be exported into individual MIDI files:
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_Pro_gestures.png|A Logic Pro project with a bunch of short blocks of music. Each block will be a "gesture".
</gallery>
For some reason, imported BMS files play 4 times as slow in cave songs. So if you import these gestures as is, they will play 4 times as slow. 
Before you export your gestures, you need to modify your gestures to run ''4 times as fast''. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each block.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>

== Inserting gestures ==
Gestures use same the note/music information as standard BMS songs. 

You should have converted all your MIDIs into BMS files. Open up one of your converted BMS files, and look for the first note/pitch value. If you used [[Pikmin 2 custom music|flaaffy]], this will most likely be somewhere after <code>0x1B</code>, <code>0x1C</code>, or <code>0x1D</code>. The note's pitch value will be followed by a <code>01</code>. Copy this note, all the way to the end of the sequence, which should be <code>FF</code>.
<gallery mode="packed-hover" widths=600px>
File:Copy_pasting_BMS_info.png|The value "2D" here is the hex value of a certain pitch, and the very first note of the sequence. Copy this, all the way to "FF".
</gallery>
To add your gesture, start it with <code>C40000015D</code>, then paste in what you copied. Each gesture should end with that <code>FF</code>. Add as many gestures as you please!
<gallery mode="packed-hover" widths=400px heights=400px>
File:BMS_file_progress_2.png|The purple lines indicate where a gesture starts.
</gallery>

== Inserting timetables ==
So, how do we choose how often gestures will play? Will a gesture play every beat? Every 1/2 a beat? You will need to add a timetable for that!
A timetable is a sequence that dictates when gestures should play. A timetable ends with <code>FFFF</code>. You can make a timetable as complex as you like. Some examples of timetables you can use are: 
* <code>0780FFFF</code> Play a gesture every 16 beats. 
* <code>03C0FFFF</code> Play a gesture every 8 beats. 
* <code>01E0FFFF</code> Play a gesture every 4 beats. 
* <code>03C003C003C001E001E001E001E003C0FFFF</code> This sequence will play a gesture every 8 beats (3x), play a gesture every 4 beats (4x), then play a gesture for 8 beats (1x), in that order. 
* <code>00F0FFFF</code> Play a gesture every 1/2 note (every 2 beats). 
* <code>0078FFFF</code> Play a gesture every 1/4 note (every beat). 
* <code>003CFFFF</code> Play a gesture every 1/8th note. 
* <code>001EFFFF</code> Play a gesture every 1/16th note. 
* <code>003C0078001EFFFF</code> This sequence will play a gesture for an 1/8th note, play a gesture for a 1/4 note, then play a gesture for a 1/16th note, in that order. 
Considering that <code>001E</code> (30 in decimal) is a 1/16th note, you can create any specific timing you want. Just add another 30 to the value for each additional sixteenth note in length. 
For example, Soil 1's enemy mix piano plays very rapidly; its timetable uses a value of 90, which looks like <code>005AFFFF</code>. The gestures last for three sixteenth notes. 
You can insert your timetables anywhere at the end of your BMS.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_3.png|Each timetable has a cyan box around it.
</gallery>

== Filling in info ==
Once you have your gestures and timetables inserted, go back and fill in those <code>00AAAA</code>, <code>00BBBB</code>, <code>00CCCC</code> placeholders with the locations of your gesture sets, timetables, and gestures you want to use. Remember that gesture sets begin with the <code>00</code>.

Also in the very beginning of your BMS, make sure the value at <code>0x6</code> has the location of where your gesture set list begins (this one will probably be fine), and the value at <code>0x14</code> has the location of where your timing ruleset list begins.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_4.png|Put the location of where the "timing ruleset list" begins here.
</gallery>

== Filling in the conductor file ==
<gallery mode="packed-hover" widths=500px heights=500px>
File:CND_functions.png|Conductor file functions.
</gallery>
In your song's associated conductor file, try to stretch out the window so that the instrument names are all in the same column if you can, like in the image above. 
Each line represents one track. You give each track a instrument (program), and what gesture set and timing ruleset to use. 
The CND infographic above does a good job explaining all the functions, but they'll be explained again down here. 

In the top left corner are three important values:
* The first value is the swing time. <code>1E</code> is 1/16th swing, while <code>3C</code> is 1/8th swing. If your song is below 100bpm, you might want to use <code>1E</code>. If its faster, try <code>3C</code> instead.
* The second value is the tempo, in hex.
* The third value is how many tracks there will be, in hex.

Each column explained:
* A: Initial delay. How many beats until this track starts running. In the vanilla game, you can notice how some song's melodies do not immediately begin playing upon the start of level. This is useful for that; ease the listener into the music.
* B/Q: If set to 1, all gestures will be delayed by an 1/8th note..
* C: Text string. You can make this say whatever you like. Useful for keeping track of what you want each track to be, like "Lead", "Trumpet", "MelodyA"/"MelodyB", "Bass", or "Drums"
* D: Track copy. Select a previous track # to copy the gestures from. If the track its copying plays "gesture 3" from its gesture set, this track will also play its "gesture 3". Often used for treasure mix instruments. You can have them use different gesture sets if you like.
* E: Echo strength.
* F: If set to 1, the values in this track's timetable will always be played in order, in a loop. If set to 0, it will randomly select values from its timetable, thus, allowing you to randomize when gestures play.
* G: Bank number.
* H: Program number. For a list of all programs in the default game and the wScenes that support them, view [[Pikmin 2 custom_music/available instruments|this page]].
* I: Gesture set, select the set # you want to use from the BMS.
* J: Timing ruleset, select the set # you want to use from the BMS.
* K: How many gestures this track will play, before playing "silent gestures". Linked to below. These function as a sort of on/off cycle.
* L: How many "silent gestures" this track will play, before playing normal gestures. Linked to above. These function as a sort of on/off cycle.
* M: If notes are being transposed down (see below), this is set to FF. But this column doesn't actually do anything, so you don't need to edit this.
* N: Transpose all notes played by this track. To transpose up, use values 1-127. To transpose down, use the sign 2 compliment (values 128-255).
* O: Volume.
* P: Stereo panning.
 
Some considerations:
* You can use the on/off cycle feature (column K and L) to make your melodic instrument "take a break" every once in a while. You can have it play 4 gestures, but then be silent for 2.
* If your timing ruleset is strict (as in, the timings for when gestures occur is always consistent), something fun to try is to have the melody be a back-and-forth between two different instruments. Set the initial delay for the second instrument to be longer than the first one, and then cleverly use the on/off cycle to have the instruments take turns sounding a gesture. This is done for the melody in the Bulblax Kingdom and Frontier Cavern for example.
* If you are using the "track copy" feature (column D), you can have the primary instrument play a melody, and have this instrument always play chords that perfectly match that melody.
* The 1/8th note delay achieved with column Q and the "track copy" feature can be used to create a stereo echo effect; make the copying track quieter and panned to a different speaker! It works better the faster your song is.

== Mapping the tracks ==
With all that done, don't forget to edit the song's [[Trackmap parameters|trackMap]]! Edit your song in the trackMap files in either <code>/user/Totaka</code> or <code>/user/Wakai</code>, and set how many instruments will be in each mix. It goes in order from: Main Mix, Task (event), Treasure (otakara), Enemy near (kehai), Combat mix, and Spiderwort mix (ground). Although you cannot find Spiderworts underground, you will have to sacrifice at least one track for that mix. You cannot set any of the mixes to have 0 instruments in them.

== Bonus: Filenames for brand new CND files ==
If you are adding a brand new CND file instead of replacing an existing one, the prefix will determine which BMS is loaded, and which wScene. 

In order to load the correct BMS file, the CND must start with the name of the BMS file. 
"caveconc.cnd", "caveconc_458435.cnd", "caveconc_Waffles.cnd", and "caveconc_Waffles_Song_2.cnd" will all load caveconc.bms. 
"caverelax.cnd", "caverelax_Gmajor.cnd", and "caverelax_mamuta_dinner.cnd" will all load caverelax.bms. 
"new_09_4.cnd", "new_09_4000.cnd", and "new_09_portal_PotaTOS.cnd" will load new_09.bms. 

For cavesoil, caveconc, and cavemetal only, the game checks for an additional "_00", "_05", and "_10" right after the prefix, so you must include this if you want the right wScene to load. For example, caveconc_05 loads wScene 31, so if you want your custom song to load wScene 31, acceptable names include "caveconc_05_waffles.cnd", "caveconc_05_52_46356.cnd", or "caveconc_05_super_boss.cnd". 

Try not to add special characters to filenames, aside from underscores. After adding your new CND file, be sure to add it to its respective trackMap file.

== Bonus: Adding new content to a vanilla BMS file ==
If you want to add new gesture sets to a BMS file, adding new hex data in the middle of a file will shift all the offsets that come after it, causing your BMS to jump to the wrong locations, and likely cause a crash. 
In order to add new content in addition to what's already in the BMS, you can reposition the gesture set list and timing ruleset list:
* Find and copy the gesture set list, and the timing ruleset list, and paste them at the end of the file. (Separate them with lots of zeros so you have lots more space to add content to these lists)
* Change <code>0x6</code> and <code>0x14</code> to point to your new gesture set list and timing ruleset list. This two values tell the game where the lists are.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Editing_vanilla_BMS_file.png|The new gesture set list and timing ruleset list we want to use will be at the bottom.
</gallery>
The game should now use these brand new lists, instead of the original instances that occur earlier in the file. They should still contain all the locations of the vanilla gesture sets/timetables from above if you want to use them, but now you can expand upon these lists with brand new entries now that you've made space for them. All new gestures, gesture sets, and timetables can occur further down your file.

[[Category:Pikmin 2]]

Creating cave music

2024-03-11T17:42:05Z

Waffles: New information

Randomly generating cave music in Pikmin 2 needs to have two files: a .bms (sequence) file, and a .cnd (conductor) file.

The BMS file type is a sequenced music format used in many games. For the cave music in Pikmin 2 however, it is specially-formatted. It mainly contains many short snippets of musical information to be randomized.

The CND files are the actual "songs"; they take specific groups of snippets from a BMS file, and endlessly puzzle-piece them together to form a coherent piece of music.

This guide will function as a walkthrough for creating your own randomly sequencing cave song. All of the editing will be done in hexadecimal.

''Requirements:''
* A DAW to create your own short MIDIs in, like FL Studio or Logic Pro. A DAW is also great for sketching out your song ideas/song's structure beforehand.
* A MIDI to BMS converter, like [[Pikmin 2 custom music|flaaffy]]. You will be generating a lot of tiny BMS files, to turn them into "gestures".
* A basic understanding of hexadecimal, and a hex editor. An editor that can dynamically resize the window is ideal (HxD on Windows, or Hex Fiend on MacOS are fantastic examples).

== Overview of file functions ==
Here are some infographics that you can reference at any time. These show all the functions of a CND file, and all the contents of a BMS file.
<gallery mode="packed-hover" widths=250px heights=250px>
File:CND_functions.png|Conductor file functions.
File:BMS_functions.png|How information is stored in a BMS file.
</gallery>

== Setting up your BMS file ==
Before you begin, set your byte grouping to "3", so every 3 bytes is visually separated by a space. This will make it easier to see stuff. 
Starting with a completely blank BMS file, begin by pasting the following:
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600
</source>
Every cave music BMS begins with this same information.
 
 
== Gesture set list ==
Exactly right after <code>34C600</code> will be a list of every gesture set's location in the BMS. Each entry is the gesture set's hexadecimal location (offset), and each entry in the sequence begins with "<code>00</code>". <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0001B0 0001BF 0001CE 0001D4 0001DA 0001E9 0001F8 0001FE 000204 00020A FFFFFF</code> 
Gesture set "0" will be at offset <code>0x1B0</code>, gesture set "1" will be at offset <code>0x1BF</code>, gesture set "2" will be at <code>0x1CE</code>, and so on. There are a total of 10 gesture sets listed in the above sequence.
 
Until we create our gesture sets, let's use <code>00AAAA</code> as placeholders so we can easily find and get back to this section later on. You can have as many gesture sets as you like; we'll create 16 entries for this tutorial. You may insert this into your BMS: 
<code>00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF</code> 
 
Our BMS should now currently look like this: 
<source lang="powershell">
AC1000 00AC11 016ECC 0210CC 0311AC 100000 AC1101 8FCC04 10CC05 11E703 00A000 03A401 00A300 01C801 00003C B1C180 010000 7FA501 01C800 000025 FE0078 C40000 0058C6 00E70E 00DF07 00006A E72E00 CF03C8 000000 4EE70E 00DF07 00006A E72E00 CF03C8 000000 60E71E 00E3E7 0000E7 0F00DF 070000 7BC600 E71F00 E3C400 00006E C40000 0155E7 0600CF 03E708 00CF03 CB0306 E70900 A00003 A70002 C80100 0096A7 0001C8 010000 8EA700 03C401 0000BE C40000 00C2C8 000000 96DA00 C600E7 0A00E7 0C00A0 0003A7 0000C8 010000 F0A700 01C801 000104 A70002 C80100 00FAA7 0003C8 010001 0EC800 000109 C40000 0118C8 000001 09C400 000118 C80000 00C5C4 000001 42E70B 00C600 C40000 0142C8 000000 C5CB06 10CB07 11CB08 04A005 04A93C 058000 A70500 C40100 014EA9 3C047F FFCF04 E70D00 C40100 00BEC6 00CB08 04A93C 047FFF CF04C6 00B1C1 400028 C600DB 04EF61 6161C6 00DB00 A40801 A40900 A40A01 EF3421 34C600 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA 00AAAA FFFFFF 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000 000000
</source>
You can also add an entire row of padding/zeros after this. You can do this for each section, to better visually separate them.
 

== Timing ruleset list ==
This is another sequence of offsets. These just point to the location of a "[[#Inserting_timetables|timetable]]", which will be located at the end of our BMS file. <code>FFFFFF</code> indicates the end of this list. 
Here is an example of how this sequence should be formatted: 
<code>0005AB 0005AB 0005AF 0005C1 0005AB 0005AB 0005C1 0005C1 0005C1 0005C1 FFFFFF</code> 
Timing ruleset "0" will use the timetable at <code>0x5AB</code>, timing ruleset "1" will also use the timetable at <code>0x5AB</code>, timing ruleset "2" will use the timetable at <code>0x5AF</code>, and so on. There are a total of 10 timing rulesets listed in the above sequence.
 
Let's use <code>00BBBB</code> as placeholders again, and create 16 of them. Insert this anywhere into your BMS: 
<code>00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB 00BBBB FFFFFF</code> 
 

== Gesture set contents ==
A ''gesture set'' is a group of many gestures. 
Here, we list each gesture set's contents (which are... the locations of gestures!). Each gesture set begins before the <code>00</code> and ends with <code>FFFFFF</code>. 
Here is an example of how the gesture set list should be formatted: 
<code>000210 00022A 000258 000281 FFFFFF 0002B4 0002D9 000303 000331 FFFFFF 000355 FFFFFF 000361 FFFFFF 0003A8 0003C2 0003F0 000419 FFFFFF 00044C 000471 00049B 0004C9 FFFFFF 0004ED FFFFFF 000543 FFFFFF 000580 FFFFFF 00059E FFFFFF</code> 
There are 10 gesture sets listed above. The first gesture set has 4 gestures, located at <code>0x210</code>, <code>0x22A</code>, <code>0x258</code>, and <code>0x281</code>. You can have any amount of gestures in a gesture set; even 1 is fine.
 
You can paste the following placeholder information for now: 
<code>00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC 00CCCC 00CCCC FFFFFF 00CCCC FFFFFF</code> 
It might be a good idea to leave a decent amount of zeros after this list; this one will expand a lot as gestures and gesture sets are added to it.
 

== How is your BMS looking? ==
If you have been copy-pasting everything correctly, your BMS will look something like this:
<gallery mode="packed-hover" widths=300px heights=300px>
File:BMS_file_progress_1.png|Orange is "gesture set list", green is "timing ruleset list", and blue is "gesture set contents"
</gallery>
Once again, you can add as much padding between each section as you want, it will work fine.
== Creating gestures ==
First, you should sketch out your song idea in your DAW, and then cut your song into tiny blocks. These blocks will be your song's individual gestures. You should also consider dragging these blocks around in various arrangements to make sure they sound good in any order. 
Once you are ready, have them nicely organized and ready to be exported into individual MIDI files:
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_Pro_gestures.png|A Logic Pro project with a bunch of short blocks of music. Each block will be a "gesture".
</gallery>
For some reason, imported BMS files play 4 times as slow in cave songs. So if you import these gestures as is, they will play 4 times as slow. 
Before you export your gestures, you need to modify your gestures to run ''4 times as fast''. How you will go about this will depend on your DAW; some will allow you to stretch entire regions of notes easily. 
Logic Pro can easily speed up MIDI regions with MIDI Transform. You want to use the "Double Speed" transformation twice on each block.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Logic_pro_double_speed.gif|Shorten the length of the MIDI by 4x, but don't change your project's tempo.
</gallery>

== Inserting gestures ==
Gestures use same the note/music information as standard BMS songs. 

You should have converted all your MIDIs into BMS files. Open up one of your converted BMS files, and look for the first note/pitch value. If you used [[Pikmin 2 custom music|flaaffy]], this will most likely be somewhere after <code>0x1B</code>, <code>0x1C</code>, or <code>0x1D</code>. The note's pitch value will be followed by a <code>01</code>. Copy this note, all the way to the end of the sequence, which should be <code>FF</code>.
<gallery mode="packed-hover" widths=600px>
File:Copy_pasting_BMS_info.png|The value "2D" here is the hex value of a certain pitch, and the very first note of the sequence. Copy this, all the way to "FF".
</gallery>
To add your gesture, start it with <code>C40000015D</code>, then paste in what you copied. Each gesture should end with that <code>FF</code>. Add as many gestures as you please!
<gallery mode="packed-hover" widths=400px heights=400px>
File:BMS_file_progress_2.png|The purple lines indicate where a gesture starts.
</gallery>

== Inserting timetables ==
So, how do we choose how often gestures will play? Will a gesture play every beat? Every 1/2 a beat? You will need to add a timetable for that!
A timetable is a sequence that dictates when gestures should play. A timetable ends with <code>FFFF</code>. You can make a timetable as complex as you like. Some examples of timetables you can use are: 
* <code>0780FFFF</code> Play a gesture every 16 beats. 
* <code>03C0FFFF</code> Play a gesture every 8 beats. 
* <code>01E0FFFF</code> Play a gesture every 4 beats. 
* <code>03C003C003C001E001E001E001E003C0FFFF</code> This sequence will play a gesture every 8 beats (3x), play a gesture every 4 beats (4x), then play a gesture for 8 beats (1x), in that order. 
* <code>00F0FFFF</code> Play a gesture every 1/2 note (every 2 beats). 
* <code>0078FFFF</code> Play a gesture every 1/4 note (every beat). 
* <code>003CFFFF</code> Play a gesture every 1/8th note. 
* <code>001EFFFF</code> Play a gesture every 1/16th note. 
* <code>003C0078001EFFFF</code> This sequence will play a gesture for an 1/8th note, play a gesture for a 1/4 note, then play a gesture for a 1/16th note, in that order. 
Considering that <code>001E</code> (30 in decimal) is a 1/16th note, you can create any specific timing you want. Just add another 30 to the value for each additional sixteenth note in length. 
For example, Soil 1's enemy mix piano plays very rapidly; its timetable uses a value of 90, which looks like <code>005AFFFF</code>. The gestures last for three sixteenth notes. 
You can insert your timetables anywhere at the end of your BMS.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_3.png|Each timetable has a cyan box around it.
</gallery>

== Filling in info ==
Once you have your gestures and timetables inserted, go back and fill in those <code>00AAAA</code>, <code>00BBBB</code>, <code>00CCCC</code> placeholders with the locations of your gesture sets, timetables, and gestures you want to use. Remember that gesture sets begin with the <code>00</code>.

Also in the very beginning of your BMS, make sure the value at <code>0x6</code> has the location of where your gesture set list begins (this one will probably be fine), and the value at <code>0x14</code> has the location of where your timing ruleset list begins.
<gallery mode="packed-hover" widths=250px heights=250px>
File:BMS_file_progress_4.png|Put the location of where the "timing ruleset list" begins here.
</gallery>

== Filling in the conductor file ==
<gallery mode="packed-hover" widths=500px heights=500px>
File:CND_functions.png|Conductor file functions.
</gallery>
In your song's associated conductor file, try to stretch out the window so that the instrument names are all in the same column if you can, like in the image above. 
Each line represents one track. You give each track a instrument (program), and what gesture set and timing ruleset to use. 
The CND infographic above does a good job explaining all the functions, but they'll be explained again down here. 

In the top left corner are three important values:
* The first value is the swing time. <code>1E</code> is 1/16th swing, while <code>3C</code> is 1/8th swing. If your song is below 100bpm, you might want to use <code>1E</code>. If its faster, try <code>3C</code> instead.
* The second value is the tempo, in hex.
* The third value is how many tracks there will be, in hex.

Each column explained:
* A: Initial delay. How many beats until this track starts running. In the vanilla game, you can notice how some song's melodies do not immediately begin playing upon the start of level. This is useful for that; ease the listener into the music.
* B/Q: If set to 1, all gestures will be delayed by an 1/8th note..
* C: Text string. You can make this say whatever you like. Useful for keeping track of what you want each track to be, like "Lead", "Trumpet", "MelodyA"/"MelodyB", "Bass", or "Drums"
* D: Track copy. Select a previous track # to copy the gestures from. If the track its copying plays "gesture 3" from its gesture set, this track will also play its "gesture 3". Often used for treasure mix instruments. You can have them use different gesture sets if you like.
* E: Echo strength.
* F: If set to 1, the values in this track's timetable will always be played in order, in a loop. If set to 0, it will randomly select values from its timetable, thus, allowing you to randomize when gestures play.
* G: Bank number.
* H: Program number. For a list of all programs in the default game and the wScenes that support them, view [[Pikmin 2 custom_music/available instruments|this page]].
* I: Gesture set, select the set # you want to use from the BMS.
* J: Timing ruleset, select the set # you want to use from the BMS.
* K: How many gestures this track will play, before playing "silent gestures". Linked to below. These function as a sort of on/off cycle.
* L: How many "silent gestures" this track will play, before playing normal gestures. Linked to above. These function as a sort of on/off cycle.
* M: If notes are being transposed down (see below), this is set to FF. But this column doesn't actually do anything, so you don't need to edit this.
* N: Transpose all notes played by this track. To transpose up, use values 1-127. To transpose down, use the sign 2 compliment (values 128-255).
* O: Volume.
* P: Stereo panning.
 
Some considerations:
* You can use the on/off cycle feature (column K and L) to make your melodic instrument "take a break" every once in a while. You can have it play 4 gestures, but then be silent for 2.
* If your timing ruleset is strict (as in, the timings for when gestures occur is always consistent), something fun to try is to have the melody be a back-and-forth between two different instruments. Set the initial delay for the second instrument to be longer than the first one, and then cleverly use the on/off cycle to have the instruments take turns sounding a gesture. This is done for the melody in the Bulblax Kingdom and Frontier Cavern for example.
* If you are using the "track copy" feature (column D), you can have the primary instrument play a melody, and have this instrument always play chords that perfectly match that melody.
* The 1/8th note delay achieved with column Q and the "track copy" feature can be used to create a stereo echo effect; make the copying track quieter and panned to a different speaker! It works better the faster your song is.

== Mapping the tracks ==
With all that done, don't forget to edit the song's [[Trackmap parameters|trackMap]]! Edit your song in the trackMap files in either <code>/user/Totaka</code> or <code>/user/Wakai</code>, and set how many instruments will be in each mix. It goes in order from: Main Mix, Task (event), Treasure (otakara), Enemy near (kehai), Combat mix, and Spiderwort mix (ground). Although you cannot find Spiderworts underground, you will have to sacrifice at least one track for that mix. You cannot set any of the mixes to have 0 instruments in them.

== Bonus: Filenames for brand new CND files ==
If you are adding a brand new CND file instead of replacing an existing one, the prefix will determine which BMS is loaded, and which wScene. 

In order to load the correct BMS file, the CND must start with the name of the BMS file. 
"caveconc.cnd", "caveconc_458435.cnd", "caveconc_Waffles.cnd", and "caveconc_Waffles_Song_2.cnd" will all load caveconc.bms. 
"caverelax.cnd", "caverelax_Gmajor.cnd", and "caverelax_mamuta_dinner.cnd" will all load caverelax.bms. 
"new_09_4.cnd", "new_09_4000.cnd", and "new_09_portal_PotaTOS.cnd" will load new_09.bms. 

For cavesoil, caveconc, and cavemetal only, the game checks for an additional "_00", "_05", and "_10" right after the prefix, so you must include this if you want the right wScene to load. For example, caveconc_05 loads wScene 31, so if you want your custom song to load wScene 31, acceptable names include "caveconc_05_waffles.cnd", "caveconc_05_52_46356.cnd", or "caveconc_05_super_boss.cnd". 

Try not to add special characters to filenames, aside from underscores. After adding your new CND file, be sure to add it to its respective trackMap file.

== Bonus: Adding new content to a vanilla BMS file ==
If you want to add new gesture sets to a BMS file, adding new hex data in the middle of a file will shift all the offsets that come after it, causing your BMS to jump to the wrong locations, and likely cause a crash. 
In order to add new content in addition to what's already in the BMS, you can reposition the gesture set list and timing ruleset list:
* Find and copy the gesture set list, and the timing ruleset list, and paste them at the end of the file. (Separate them with lots of zeros so you have lots more space to add content to these lists)
* Change <code>0x6</code> and <code>0x14</code> to point to your new gesture set list and timing ruleset list. This two values tell the game where to the lists are.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Editing_vanilla_BMS_file.png|The new gesture set list and timing ruleset list we want to use will be at the bottom.
</gallery>
The game should now use these brand new lists, instead of the original instances that occur earlier in the file. They should still contain all the locations of the vanilla gesture sets/timetables from above if you want to use them, but now you can expand upon these lists with brand new entries now that you've made space for them. All new gestures, gesture sets, and timetables can occur further down your file.

[[Category:Pikmin 2]]

File:Editing vanilla BMS file.png

2024-03-11T17:28:54Z

Waffles: For the "Creating randomly sequencing cave music" page.

== Summary ==
For the "Creating randomly sequencing cave music" page.