Pikmin Technical Knowledge Base - User contributions [en]

Main Page

2019-08-15T14:31:04Z

Colou: Added link to the interactive BMS files page.

{{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 new fans 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 [http://pikminfanon.com/ Pikmin Fanon] instead.
** Unused content or regional differences. Try [http://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="25%;" | ''Pikmin'' (and ''New Play Control! Pikmin'')
! width="25%;" | ''Pikmin 2'' (and ''New Play Control! Pikmin 2'')
! width="25%;" | ''Pikmin 3''
! width="25%;" | ''Hey! Pikmin''
|-

! colspan="4" | 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]]
|-

! colspan="4" | File lists
|-
| valign="top" |
* [[Pikmin directory tree|Directory tree]]
* [[JAM file list|JAM file list (Pikiseq.arc)]]
* [[STX file list|STX 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]]

| valign="top" |
* [[Pikmin 3 directory tree|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)]]

|-

! colspan="4" | Constants
|-
| valign="top" |
* [[Pikmin identifiers|Identifiers]]

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

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

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

|-

! colspan="4" | 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" |

|-

! colspan="4" | 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]]

| 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)]]
|-

! colspan="4" | 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]]

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

| valign="top" |

|-

! colspan="4" | 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 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" |

|-

! colspan="4" | Explanations and notes
|-
| valign="top" |
* [[Pikmin file formats|File formats]]
* [[Pikmin unread files|Unread files]]
* [[Pikmin disable archives trick|Disable loading from archives]]
* [[Pikmin Emperor crash|Emperor crash]]
* [[Minty Ramblings]]
* [[Ambrosia Ramblings]]
* [[Disassembly instructions]]

| valign="top" |
* [[Cave spawning]]
* [[Custom models]]
* [[Submerged Castle oddities|Special cave properties]]
* [[How Pikmin 2 loads text|How ''Pikmin 2'' loads text]]
* [[User:Untitled-1/Sound_Replacement_Tutorial|Sound Replacement Tutorial]]
* [[Creating Interactive BMS Files]]
* [[Disassembly instructions]]

| valign="top" |
* [[Pikmin 3 oddities|Oddities]]

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

|-

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

| valign="top" |
* [[Cave Creator]]
* [[Pikmin 2 Routes Editor]]
* [[obj2grid]]
* [[BMDCubed]]
* [[SuperBMD]]
* [[pikminBMGtool]]
* [[btk-conv]]

| valign="top" |

| valign="top" |

|}

== 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

2019-08-15T14:27:58Z

Colou: Separated this from the main BMS page.

{{todo|Finish the tutorial.}}

So you want your pikmin 2 music to have the interactivity of normal pikmin 2 songs? Well, I can tell you how to do that. While Flaaffy made bms files dont have interactivity, enough hex editing can fix that. Note that this all only applies to the four overworld themes. Caves use a completely different system for interactive music that isn't yet understood. Also note that music made this way wont have the Louie swing variant, just the interactive event tracks(working, treasure, enemy near, combat, spiderwort) and the sunset version.

== Getting started ==
First off, make your midi. It's good to know ahead of time what tracks will serve what purpose. Remember that the combined total of all tracks can't exceed 16. I usually have between 5 - 8 main tracks and 1-2 for each of the special mixes. also make sure you have AudioRes/Seqs/seq.arc extracted, with all the bms files ready to replace. n_tutorial.bms is the Valley of Repose theme, Forest.bms is the Awakening Wood theme, yakushima.bms is the Perplexing Pool theme, and last.bms is the Wistful Wild theme.

Next, make the bms of your midi like you normally would with Flaaffy. The instruments and banks you choose with flaaffy don't matter. Make sure each track only loads an instrument and program once at the beginning of the track and never again. Get your bms and open it in HxD. Also open specifically the original last.bms in HxD. Regardless of what song your making, last.bms is the easiest to work with by far.

In last.bms, delete everytyhing after <code>0x04 90</code>, leaving just the header. Now, in your flaaffy bms do a search for the first instance of <code>a4 20</code> in the bms, and delete everything before that. It should be around 2 lines in. Now, cut and paste whats left of the flaaffy bms to the end of last.bms.

== Staying Organized ==
You will surely want a text file with notes to keep yourself orgranized, because things can get messy coming up. Look at figure 1 to see how I format mine. From now on a track of the flaaffy bms will be reffered to as a "note track" and the actual tracks of the bms are just "tracks". You'll want to write down the offset of every instrument youre using, the offset of every note track, and what track uses what note track and instrument. Using this will make the "track setting" step far easier.

== Setting Loops ==

Now that you have the base of your interactive bms, its time to set the looping for every track. First, go to <code>0x04 90</code>. You should see <code>A4 20</code>. Remember the offset this <code>a4 20</code> is at. Now search for the next <code>a420</code> in the bms. Now you're at the start of the next note track. Before anything else, add padding 00s to move the a420 you just found to the start of a new line. It will simplify steps in the future. Look back a bit and you will see the last track's looping jump branch. In a standard flaaffy bms, it will be an offset to the start of the note track followed by a "E7". Replace this E7 with FF and change the offset right before it to the start of the previous <code>a4 20</code> plus 0x6. For example. If a track has a <code>a4 20</code> starting at <code>0x0d 90</code>, the loop offset at the end should look like this, <code>C8 00 00 0d 96</code>. Continue to do this for every note track, search for <code>a4 20</code>, move it to the start of next line, change the loop offset to point to the <code>a4 20</code> +6, change the E7 to FF. do this until you get to the final track. Make sure as you do this, take notes of the offset of every <code>a4 20</code>. The final line has to be 32 byte aligned, so add 00 padding if needed. You will see a A4 20

== Setting Instruments ==
Go to the top part of your bms. Specifically, jump to offset <code>0x 03 2b</code>. You will see a C4, followed by 00 00 01 8E. This part shouldn't be touched, but the part after it is important. There should be a <code>A4 20 XX A4 21 XX</code>. The byte following a4 20 is the bank this instrument will use. The a4 21 is the program. Make sure you know what bank and programs can be used within the bms you are replacing. Also keep in mind these are hex values, so program 14 would be entered as <code>A4 21 0e</code>, not <code>A4 21 14</code>. Continue to look around for these a4 21s, and take notes on the program number and the offset to the <code>C4</code> in the <code>C4 00 00 01 8E</code> before it. The instrument offset at <code>0x 04 53</code> specifically is strange because it sets a program twice, only the second one matters though.

== Setting Tracks ==
Now that you have the loops for all the note tracks set up, and all the instrument setting in place, its time to actually assign the note track offsets and instrument offsets for each track.

== Final Touches ==

BMS file

2019-08-15T14:27:39Z

Colou: Touched up some grammar, and moved the Interactive Music tutorial to it's own page (hopefully that's alright with everyone?) Also added mention to the Pikmin 2 BMS file list page, although perhaps that could be merged with this page instead?

A '''.bms''' file holds data for sequenced music in Pikmin 2. BMS files are similar to [[wikipedia:MIDI|MIDI files]], but have many more advanced features. Custom BMS files can be
made with Flaaffy by Arookas (which can be found [https://github.com/arookas/flaaffy/releases here]) however Yoshi2's fork of Flaaffy is better suited to making BMS files for Pikmin 2. You can find that [https://github.com/RenolY2/flaaffy/releases here.]

== Documentation: ==

{{todo|Actually document every byte of a bms header and music data and what it all means.}}

== List of BMS files ==

A full list of all the BMS files in Pikmin 2 can be found [[Pikmin_2_BMS_file_list|here]].

== Interactive Music ==

A lot of BMS music in Pikmin 2 is interactive, meaning that parts of it change depending on what you do in the game. BMS files produced by Flaaffy do not support this by default, however they can be modified to be interactive.
* A tutorial to do this can be found [[Creating_Interactive_BMS_Files|here]]. This currently only applies to overworld music and will not work for caves.