Pikmin Technical Knowledge Base - User contributions [en]

Creating custom caves with Drought Ender's tool

2025-02-27T15:44:42Z

GameCubing8619:

work on this during the weekend -cube

Creating Custom Caves With Drought Enders Tool

2025-02-27T15:41:17Z

GameCubing8619: GameCubing8619 moved page Creating Custom Caves With Drought Enders Tool to Creating custom caves with Drought Ender's tool: Misspelled title

#REDIRECT [[Creating custom caves with Drought Ender's tool]]

Creating custom caves with Drought Ender's tool

2025-02-27T15:41:17Z

GameCubing8619: GameCubing8619 moved page Creating Custom Caves With Drought Enders Tool to Creating custom caves with Drought Ender's tool: Misspelled title

Creating custom caves with Drought Ender's tool

2025-02-27T15:36:18Z

GameCubing8619: fix title

Creating custom caves with Drought Ender's tool

2025-02-27T15:28:06Z

GameCubing8619: Created page with "Start this on the weekend -- CUBE"

Start this on the weekend -- CUBE

DOL-Ckit

2025-02-10T15:40:08Z

GameCubing8619: fix grammer

__TOC__

==The Project.py==
So in ckit it allows you to hook into addresses and append c code to the dol of a game which is done through building c sources and hooking branchlinks through the project.py. For example, let's say you want to hook the file main.c you would have to hook it like this.

{|class="wikitable sortable mw-collapsible"
! hooking a file
<div align="left"><source>
p.add_c_file("main.c")
p.hook_branchlink(memory address for the function, "function")
p.hook_branchlink(0x803bb8a8, "widescreen2")
p.hook_branchlink(0x8041ae14, "widescreen3")
p.hook_branchlink(0x8043502c, "widescreen4")

</source></div>
|}

{{credits|GameCubing8619}}

Drought Enders Cave Creator

2025-02-10T15:38:41Z

GameCubing8619: fix grammer

__TOC__

==The Program==
The so-called "New Cave Creator", has for the most part replaced jimbles by a long shot and can be found on the github here https://github.com/Drought-Ender/Drought-Cave-Creator

{{credits|Drought Ender, GameCubing8619}}

Pikmin 2 instructions

2025-02-10T15:28:45Z

GameCubing8619: added some formats ig

Helpful instructions for editing and handling ''Pikmin 2'''s files. This guide assumes you have some basic knowledge on navigating folders, opening files, using commands, etc.
See [[General instructions#Obtaining a game's files|obtaining a game's files]] if you are unsure on how to do so.

You can view and edit a lot of the game's files. You can read them without any worry, but if you want to change them and have those changes apply in-game, see [[General instructions#Saving changes|saving changes]] in [[general instructions]].
{{todo|Instructions for how to edit music.}}

==Tools and files==

Here are some prominent files that come up when modding.
.DOL Segmented executable binary format (similar to .elf) which contains the games compiled source.
.SZS: Archive files similar to .ZIP or .RAR archive files. SZS files are RARC archives compressed with Yaz0 compression.
.ARC: Archive files similar to .ZIP or .RAR archive files. ARC files are RARC archives not compressed with Yaz0 compression.
.TXT: Generic plaintext files. Use Notepad++ to preserve the Shift-JIS encoding.
.BMD/.BDL: Proprietary 3D model files.
.BMS: Sequenced audio files, similar to MIDI but more advanced. [https://pikmintkb.com/wiki/Pikmin_2_BMS_file_list List]
.CND: Files that control how various sequences in a BMD file are randomly chained together in a complex system. Used for cave music.
[https://pikmintkb.com/wiki/Pikmin_2_CND_file_list List]
.AST: Streamed audio files. [https://pikmintkb.com/wiki/AST_file_list List]
.AW: Soundbank files.
.BMG: Used to store in-game text strings.
.BLO: UI screen data.
.BTI: Textures.
.BTK: Animated textures.
.STB: Cutscene data.
.THP: Prerendered videos (GC/Wii)
.WEBM: Prerendered videos (Switch)
.JPC: Particle effect container. [https://pikmintkb.com/wiki/JPC_particles List]
.JPA: Particle effect.
.BCA: Full animation data.
.BPK: Animation data. (still being researched)
.BCK: Keyframed animation data.

Here are some prominent tools:

[https://www.romhacking.net/utilities/1024/ Lunaboy's RARC Tools]- Used for extracting and converting RARC archives. For szs files, simply rename the converted file from file.arc to file.szs.
[https://notepad-plus-plus.org/downloads/ Notepad++] - Used for editing text files, many of which need to preserve Shift-JIS encoding.
[https://github.com/RenolY2/pikmin-tools/releases/download/v1.0.1.3/piktools-1.0.1.3.zip Gen & Route Editor] - Used for editing overworld generation and pikmin carrying routes.
[https://github.com/Drought-Ender/Drought-Cave-Creator/archive/refs/heads/main.zip Drought's Cave Creator] - Used for creating and modifiying cave files, cave lighting, and cave unit definition files.
[https://xayr.gay/tools/SoundModdingToolkit/6.3.3/PIKMIN2_SoundModdingToolkit_6.3.3_win64.zip Pikmin 2 Sound Modding Toolkit] - Used for modyfing sounds in the game.
[https://xayr.gay/tools/jaimaker1/JAIMaker+JAISeqX1.5.9.zip JAIMaker] - Used for creating custom sequenced music as BMS files. Interactive music and cave music require additional hex editing.
[https://github.com/XAYRGA/jatast/releases/download/stable/publish_win64.zip JATAST] - Used for converting .wav files into .ast files for streamed music.
[https://github.com/RenolY2/pikminBMG/archive/refs/tags/v0.7.4.zip pikminBMG] - Used for editing text in the game.
[https://github.com/RenolY2/pyblo2-gui/releases/download/v0.7.3/blo-gui-editor-v0.7.3.zip pyblo2-gui] - Used for modyfing blo files.
[https://mega.nz/file/m4YzXb4b#pXMGCSapWQjB72mushjH0DD7XQOwrMQOm97d_F_CSHs FinModelUtility] - Used for converting BMD files to formats that can be imported into any 3D modeling software.
[https://github.com/pish-pish/SuperBMD/releases/download/v2.4.9.2/SuperBMD.zip SuperBMD] - Used for converting FBX and DAE files back to BMD.
[https://github.com/riidefi/RiiStudio/releases/download/Alpha-5.11.1/RiiStudio_Windows.zip RiiStudio] - Used for BMD materials editing. (Pish don't kill me GUI is just easier for now)
[https://github.com/RenolY2/obj2grid/archive/refs/tags/v0.8.zip obj2grid] - Used for converting between .OBJ 3D files and pikmin 2's collision formats.
[https://github.com/LagoLunatic/GCFT/releases/tag/1.10.0 GameCube File Tools] - Used for modification of many GameCube/early Wii era formats, notably BTI files. It can also compress .arc archives to szs.
Hex editor - needed for additional editing of other files such as .BIN binary files. An editor of choice is HxD: (https://mh-nexus.de/en/hxd/)
More tools can be found in Hocotate Hacker if needed. Compiled builds for many of these tools are for Windows, but macOS and Linux users can compile many from source.

==Cave editing==

You can make custom caves with Drought's Cave Creator.

The BgmList files in <code>user/Totaka</code> control what cave song is used for each sublevel. <code>BgmList_Tutorial.txt</code> is used for Valley of Repose caves, <code>BgmList_Forest.txt</code> is used for Awakening Wood caves, <code>BgmList_Yakushima.txt</code> is used for Perplexing Pool caves, <code>BgmList_Last.txt</code> is used for Wistful Wild caves, and <code>ChallengeBgmList.txt</code> is used for caves in Challenge Mode. When adding more sublevels to any cave, you must remember to add more cave songs to the applicable BgmList text file, or else the game will crash.

You can change the listed CND file to change what song plays in a sublevel.

To add completely new cave music tracks,

1) Make a new BMS file in <code>AudioRes/Seqs/Seq.arc</code> called <code>new_09.bms</code> or so in order, 9, 10, 11, etc

2) Make a new CND file in <code>AudioRes/Conductor.arc</code> <code>new_09_0.cnd</code>, just the BMS name with _0 (leave the CND blank if you don't want interactivity, or see the CND file guide below to make a full track.)

3) Add the new BMS in the <code>user/Totaka/BgmList.txt</code> after the new_0-8

4) Add the new CND in <code>user/Totaka/trackMap_Cond_T.txt</code>. If not doing interactivity, copy paste new_00's entry with the new CND's name; otherwise, see the cave music guide for more details.

5) Add a new wScene for your song using the Sound Modding Toolkit (see guide below), new_09 will use <code>wScene46.aw</code> and so on in order. <code>wScene48.aw</code> is used for the Submerged Castle theme and Waterwraith approaching theme, so it's a good idea to skip from <code>new_09.bms</code> to <code>new_12.bms</code> so you skip to <code>wScene49.aw</code>.

6) Set the new song to be used in the applicable BgmList file for your area/challenge mode BgmList.

==Overworld editing==

==Model replacement==

==Custom sounds and music==

Custom streamed music can be made with JATAST, a command line tool for converting WAV files to AST files. When converting a .wav file, have the loop points be contained in the .wav file itself. It is important to have new .ast files encoded with ADPCM4, as this helps with disc read speeds. To convert .wav files to ADPCM4 .asts, run this in a command prompt or terminal: <code>jatast yoursong.wav newsong.ast -encode-format adpcm4</code>

Custom sequenced music can be made with either flaaffy (command-line) or JAIMaker (GUI-based), tools that convert MIDI files to BMS files. For non-interactive sequenced music (such as the world map theme and high scores theme), a simple MIDI conversion will suffice. If you want interactive overworld music, or randomized interactive cave music, see these two guides:

[https://pikmintkb.com/wiki/Creating_Interactive_BMS_Files Creating interactive area music]

[https://pikmintkb.com/wiki/Creating_cave_music Creating interactive cave music]

Replacement sounds, custom samples and new instruments can be done with the Pikmin 2 Sound Modding Toolkit. This [https://pikmintkb.com/wiki/Sound_Replacement_Tutorial page] outlines the process, as well as a process for doing custom sound effects.

==Running your modified game==
See [[General instructions#Running a modified game]].

[[Category:Pikmin 2]]
[[Category:Instructions]]

User:GameCubing8619

2025-02-10T15:20:11Z

GameCubing8619:

Helped On Hallows Haunt And Is Currently Working On Return To PNF 404

Main Page

2025-02-10T15:18:46Z

GameCubing8619: removed my old notes since they were kinda basic

{{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]]
* [[Dandori Battles]]
* [[Disabling Pikmin]]

|-

! colspan="5" | File formats
|-
| valign="top" |
* Archive Formats
** [[Paired ARC+DIR file]]
** [[BUN file]] (also ANM)
** [[BARC file]]
* 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]]
* [[Save Files]]

|-

! 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" | Screens
|-
| valign="top" |

| valign="top" |

| 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]]
* [[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]]

Main Page

2024-06-30T18:20:20Z

GameCubing8619:

{{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)
** [[BARC file]]
* Binary formats
** [[MOD file]] (3D Model)
** [[ACT file]] (Hierarchy Model File)
** [[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]]
** [[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]]

ACT file

2024-06-30T18:18:15Z

GameCubing8619: Created page with "A File Typically from the 3d max plugin from the Character Pipeline SDK, .act is a hierarchy type file for the models that are outputted"

A File Typically from the 3d max plugin from the Character Pipeline SDK, .act is a hierarchy type file for the models that are outputted

Pikmin 2 memory addresses

2024-05-20T09:51:03Z

GameCubing8619: pre pended with 0x, it not being there annoyed me to much lol

{{DISPLAYTITLE:''Pikmin 2'' memory addresses}}
A list of memory addresses for important things in ''Pikmin 2''.

==Leader coordinates==
{| class="wikitable sortable"
|-
! rowspan="2" | Variable || colspan="7" | Address || rowspan="2" | Type || rowspan="2" | Notes
|-
! GC US Final || GC EU || GC JP || GC US Demo || Wii US || Wii EU || Wii JP
|-
! Olimar's X
| <code>0x80E0D9B0</code> || <code>0x80E11C50</code> || <code>0x80E0F7B0</code> || <code></code> || <code>0x923BC714</code> || <code></code> || <code></code> || 4-byte float || Horizontal movement.
|-
! Olimar's Y
| <code>0x80E0D9B4</code> || <code>0x80E11C54</code> || <code>0x80E0F7B4</code> || <code></code> || <code>0x923BC718</code> || <code></code> || <code></code> || 4-byte float || Vertical movement; positive is up.
|-
! Olimar's Z
| <code>0x80E0D9B8</code> || <code>0x80E11C58</code> || <code>0x80E0F7B8</code> || <code></code> || <code>0x923BC71C</code> || <code></code> || <code></code> || 4-byte float || Horizontal movement.
|-
! Louie/President's X
| <code>0x80E0DCD0</code> || <code>0x80E11F70</code> || <code>0x80E0FAD0</code> || <code></code> || <code>0x923BCA54</code> || <code></code> || <code></code> || 4-byte float || Horizontal movement.
|-
! Louie/President's Y
| <code>0x80E0DCD4</code> || <code>0x80E11F74</code> || <code>0x80E0FAD4</code> || <code></code> || <code>0x923BCA58</code> || <code></code> || <code></code> || 4-byte float || Vertical movement.
|-
! Louie/President's Z
| <code>0x80E0DCD8</code> || <code>0x80E11F78</code> || <code>0x80E0FAD8</code> || <code></code> || <code>0x923BCA5C</code> || <code></code> || <code></code> || 4-byte float || Horizontal movement.
|}

==Pikmin count==

{| class="wikitable sortable"
|-
! rowspan="2" | Variable || colspan="7" | Address || rowspan="2" | Type || rowspan="2" | Notes
|-
! GC US Final || GC EU || GC JP || GC US Demo || Wii US || Wii EU || Wii JP
|-
! Red Leafs in Onion
| <code>0x8092F98B</code> || <code>0x80942BAA</code> || || || || || || 2-byte unsigned int ||
|-
! Red Buds in Onion
| <code></code> || <code>0x80942BAE</code> || || || || || || 2-byte unsigned int ||
|-
! Red Flowers in Onion
| <code></code> || <code>0x80942BB2</code> || || || || || || 2-byte unsigned int ||
|-
! Purple Leafs in Ship
| <code></code> || <code>0x80942BC2</code> || || || || || || 2-byte unsigned int ||
|-
! Purple Buds in Ship
| <code></code> || <code>0x80942BC6</code> || || || || || || 2-byte unsigned int ||
|-
! Purple Flowers in Ship
| <code></code> || <code>0x80942BCA</code> || || || || || || 2-byte unsigned int ||
|-
! White Leafs in Ship
| <code></code> || <code>0x80942BCE</code> || || || || || || 2-byte unsigned int ||
|-
! White Buds in Ship
| <code></code> || <code>0x80942BD2</code> || || || || || || 2-byte unsigned int ||
|-
! White Flowers in Ship
| <code></code> || <code>0x80942BD6</code> || || || || || || 2-byte unsigned int ||
|-
! Yellow Leafs in Onion
| <code></code> || <code>0x80942BB6</code> || || || || || || 2-byte unsigned int ||
|-
! Yellow Buds in Onion
| <code></code> || <code>0x80942BBA</code> || || || || || || 2-byte unsigned int ||
|-
! Yellow Flowers in Onion
| <code></code> || <code>0x80942BBE</code> || || || || || || 2-byte unsigned int ||
|-
! Blue Leafs in Onion
| <code></code> || <code>0x80942B9E</code> || || || || || || 2-byte unsigned int ||
|-
! Blue Buds in Onion
| <code></code> || <code>0x80942BA2</code> || || || || || || 2-byte unsigned int ||
|-
! Blue Flowers in Onion
| <code></code> || <code>0x80942BA6</code> || || || || || || 2-byte unsigned int ||
|}

==Adventure stats==

{| class="wikitable sortable"
|-
! rowspan="2" | Variable || colspan="7" | Address || rowspan="2" | Type || rowspan="2" | Notes
|-
! GC US Final || GC EU || GC JP || GC US Demo || Wii US || Wii EU || Wii JP
|-
! Current day
| <code>0x80B0B4B8</code> || <code>0x80B0FBD8</code> || || || || || || 4-byte unsigned int || Day 1 is <code>0</code>, day 2 is <code>1</code>, etc.
|-
! Current total Poko count
| <code>0x8092F85C</code> || <code>0x80942A7C</code> || || || || || || 4-byte unsigned int ||
|-
! Current underground Poko count
| <code>0x8092F860</code> || || || || || || || 4-byte unsigned int ||
|-
! Ultra-spicy spray count
| || <code>0x80942A54</code> || || || || || || 4-byte unsigned int ||
|-
! Ultra-bitter spray count
| || <code>0x80942A58</code> || || || || || || 4-byte unsigned int ||
|}

== Gameplay control ==
{| class="wikitable sortable"
|-
! rowspan="2" | Variable || colspan="7" | Address || rowspan="2" | Type || rowspan="2" | Notes
|-
! GC US Final || GC EU || GC JP || GC US Demo || Wii US || Wii EU || Wii JP
|-
! Current cutscene timer ID
| || <code>0x809FDE6E</code> || || || || || || 2-byte unsigned int ||
|-
! Current RNG seed
| <code>0x805148A8</code> || <code>0x805155A0</code> || <code>0x805163A8</code> || <code>0x805147E0</code> || || || || 4-byte unsigned int ||
|}

[[Category:Memory addresses]]
[[Category:Pikmin 2]]

Cubes Yap Notes

2024-05-20T09:31:09Z

GameCubing8619:

__TOC__

==Versions==
pikmin 2 has three main versions that are modded the first one is a version know as USA demo final and is a demo of pikmin 2 but this demo contains the entire game inside
and this version was moddeed more at one point because usa demo had a more complete symbol map then the next version im going to talk about. Another Version is final which is the usa retail release of pikmin 2 and the last version that is modded is pikmin 2 wii and is pretty self explanatory

==PPC ASM==
Since we don't have access to the source of pikmin2 we mostly have to deal with the custom asm from the ppc geko processer of the gamecube with dolphin debugger for the most part BUT there are some options like for example ckit which allows u to hook into addresses and append c code to the dol of a game allows for some pretty cool stuff. and there also is the fan project pikmin2 decomp which is a fan devoted project where fans of the game try to rebulid the soucre from scratch is also a option and is currently at 40% completion as of 1/25/2024.

==The .dol==
bla bla in short the file where the src code is and is comprised of a few different sections/splits like .data and .ctors for example. theres also injectors that can shift forward the stack db_stack and osarena in memory so more code can be added to the dol for more modding. within the dol memory mostly looks like, dol sections(.text,.data),stack,db_stack,OSarena

==Jsystem==
During The GameCube/Wii Era Nintendo First Party Games Used A Lib Called Jsystem for development Which consisted of many different libs, and some examples of these libs within the jsystem were jstudio,j3d,j2d,jaudio,jmessage, and jutility.

==STB Findings==
Wip

==Cave Gen==
in the layout.txt of a texts.szs file for a cave unit is the gen and inside this file it has the gen from everything from enemy placment to the location of plants and cave holes/geysers and we also have the angle parameter which is the angle of the way the object spawns.we also have the differnt types of spawn in a number list from 0-8 as show here.
{| class="wikitable sortable"
|0 - Weak Enemy
|-
|1 - Strong Enemy
|-
|2 - Treasure
|-
|3 - Does Nothing
|-
|4 - Geysers/Cave Hole
|-
|5 - Spawn In-between Rooms/Where They Connect
|-
|6 - Plant Spawn
|-
|7 - Ship Spawn
|-
|8 - Special Enemy

|}

H4M file

2024-05-20T09:23:20Z

GameCubing8619:

A Format Made By Hudson Soft that contain the ending credits and the video demos that play in pikmin 1 and are found in dataDir\MovieData.
{| class="wikitable sortable"
! Movie || Description
|-
| <code>cntA_S.h4m</code>
| A Pause Screen Demo That Plays When There Is Long Periods Of Inactivity.
|-
| <code>cntB_S.h4m</code>
| A Pause Screen Demo That Plays When There Is Long Periods Of Inactivity.
|-
| <code>cntC_S.h4m</code>
| A Pause Screen Demo That Plays When There Is Long Periods Of Inactivity.
|-
| <code>cntD_S.h4m</code>
| A Pause Screen Demo That Plays When There Is Long Periods Of Inactivity.
|-
| <code>sr_S.h4m</code>
| The Ending Credits Of The Game With The Normal Non 100% Ending At The End.
|-
| <code>srhp_S.h4m</code>
| The Ending Credits Of The Game With The "Best" Ending At The End.
|}
{{Credits|Minty_Meeo,}}

H4M file

2024-05-20T09:21:05Z

GameCubing8619:

H4M file

2024-05-20T09:15:14Z

GameCubing8619:

H4M file

2024-05-20T09:12:59Z

GameCubing8619:

H4M file

2024-05-20T09:11:15Z

GameCubing8619:

H4M file

2024-05-20T09:10:39Z

GameCubing8619:

A Format Made By Hudson Soft that are pre rendered cutscenes in pikmin 1 and are found in dataDir\MovieData
within the Moive Data Folder there are six different files each with there own moive, and here is what is in them
{| class="wikitable sortable"
! Property || Description
|-
| <code>name</code>
| The internal name of the treasure (used when spawning treasures in caves).
|-
| <code>archive</code>
| Name of the <code>.szs</code> archive containing the model, in </code>/user/Abe/pellet/region</code>.
|-
| <code>bmd</code>
| Name of the [[BMD file|<code>.bmd</code> model]] within the <code>.szs</code> archive.
|-
| <code>animmgr</code>
| File name of the animation manager in <code>otakara_texts.szs</code>.
|-
| <code>colltree</code>
| Name of the collision text file in <code>otakara_texts.szs</code>.
|-
| <code>radius</code>
| {{unsure|Collision processing radius?}}
|-
| <code>p_radius</code>
| Radius of shadow and where Pikmin pick up the treasure base.
|-
| <code>height</code>
| Height offset of the treasure model.
|-
| <code>inertiascaling</code>
| A number that relates to the moment of inertia, i.e., how much it resists angular change. Higher values translates to higher resistance and reduced wobbling intensity.
|-
| <code>particletype</code>
| {{unknown}}.
|-
| <code>numparticles</code>
| {{unknown}}.
|-
| <code>particlesize</code>
| {{unknown}}.
|-
| <code>friction</code>
| {{unsure|Likely unused.}}
|-
| <code>min</code>
| Minimum Pikmin strength needed to carry.
|-
| <code>max</code>
| Maximum number of Pikmin that can carry.
|}
{{Credits|Minty_Meeo,}}

H4M file

2024-05-20T09:09:00Z

GameCubing8619:

H4M file

2024-05-20T09:03:52Z

GameCubing8619:

User:GameCubing8619

2024-03-17T08:16:03Z

GameCubing8619:

Helped On Hallows Haunt And Is Currently Working On Return To PNF 404 and Creaturemin

Cubes Yap Notes

2024-03-14T02:24:31Z

GameCubing8619: /* Jsystem */

__TOC__

==Versions==
pikmin 2 has three main versions that are modded the first one is a version know as USA demo final and is a demo of pikmin 2 but this demo contains the entire game inside
and this version was moddeed more at one point because usa demo had a more complete symbol map then the next version im going to talk about. Another Version is final which is the usa retail release of pikmin 2 and the last version that is modded is pikmin 2 wii and is pretty self explanatory

==PPC ASM==
Since we don't have access to the source of pikmin2 we mostly have to deal with the custom asm from the ppc geko processer of the gamecube with dolphin debugger for the most part BUT there are some options like for example ckit which allows u to hook into addresses and append c code to the dol of a game allows for some pretty cool stuff. and there also is the fan project pikmin2 decomp which is a fan devoted project where fans of the game try to rebulid the soucre from scratch is also a option and is currently at 40% completion as of 1/25/2024.

==Jsystem==
During The GameCube/Wii Era Nintendo First Party Games Used A Lib Called Jsystem for development Which consisted of many different libs, and some examples of these libs within the jsystem were jstudio,j3d,j2d,jaudio,jmessage, and jutility.

==STB Findings==
Wip

==Cave Gen==
in the layout.txt of a texts.szs file for a cave unit is the gen and inside this file it has the gen from everything from enemy placment to the location of plants and cave holes/geysers and we also have the angle parameter which is the angle of the way the object spawns.we also have the differnt types of spawn in a number list from 0-8 as show here.
{| class="wikitable sortable"
|0 - Weak Enemy
|-
|1 - Strong Enemy
|-
|2 - Treasure
|-
|3 - Does Nothing
|-
|4 - Geysers/Cave Hole
|-
|5 - Spawn In-between Rooms/Where They Connect
|-
|6 - Plant Spawn
|-
|7 - Ship Spawn
|-
|8 - Special Enemy

|}

Cubes Yap Notes

2024-03-14T02:17:52Z

GameCubing8619: /* STB Findings */

__TOC__

==Versions==
pikmin 2 has three main versions that are modded the first one is a version know as USA demo final and is a demo of pikmin 2 but this demo contains the entire game inside
and this version was moddeed more at one point because usa demo had a more complete symbol map then the next version im going to talk about. Another Version is final which is the usa retail release of pikmin 2 and the last version that is modded is pikmin 2 wii and is pretty self explanatory

==PPC ASM==
Since we don't have access to the source of pikmin2 we mostly have to deal with the custom asm from the ppc geko processer of the gamecube with dolphin debugger for the most part BUT there are some options like for example ckit which allows u to hook into addresses and append c code to the dol of a game allows for some pretty cool stuff. and there also is the fan project pikmin2 decomp which is a fan devoted project where fans of the game try to rebulid the soucre from scratch is also a option and is currently at 40% completion as of 1/25/2024.

==Jsystem==
During The

==STB Findings==
Wip

==Cave Gen==
in the layout.txt of a texts.szs file for a cave unit is the gen and inside this file it has the gen from everything from enemy placment to the location of plants and cave holes/geysers and we also have the angle parameter which is the angle of the way the object spawns.we also have the differnt types of spawn in a number list from 0-8 as show here.
{| class="wikitable sortable"
|0 - Weak Enemy
|-
|1 - Strong Enemy
|-
|2 - Treasure
|-
|3 - Does Nothing
|-
|4 - Geysers/Cave Hole
|-
|5 - Spawn In-between Rooms/Where They Connect
|-
|6 - Plant Spawn
|-
|7 - Ship Spawn
|-
|8 - Special Enemy

|}

Cubes Yap Notes

2024-03-14T02:17:36Z

GameCubing8619:

__TOC__

==Versions==
pikmin 2 has three main versions that are modded the first one is a version know as USA demo final and is a demo of pikmin 2 but this demo contains the entire game inside
and this version was moddeed more at one point because usa demo had a more complete symbol map then the next version im going to talk about. Another Version is final which is the usa retail release of pikmin 2 and the last version that is modded is pikmin 2 wii and is pretty self explanatory

==PPC ASM==
Since we don't have access to the source of pikmin2 we mostly have to deal with the custom asm from the ppc geko processer of the gamecube with dolphin debugger for the most part BUT there are some options like for example ckit which allows u to hook into addresses and append c code to the dol of a game allows for some pretty cool stuff. and there also is the fan project pikmin2 decomp which is a fan devoted project where fans of the game try to rebulid the soucre from scratch is also a option and is currently at 40% completion as of 1/25/2024.

==Jsystem==
During The

==STB Findings==

==Cave Gen==
in the layout.txt of a texts.szs file for a cave unit is the gen and inside this file it has the gen from everything from enemy placment to the location of plants and cave holes/geysers and we also have the angle parameter which is the angle of the way the object spawns.we also have the differnt types of spawn in a number list from 0-8 as show here.
{| class="wikitable sortable"
|0 - Weak Enemy
|-
|1 - Strong Enemy
|-
|2 - Treasure
|-
|3 - Does Nothing
|-
|4 - Geysers/Cave Hole
|-
|5 - Spawn In-between Rooms/Where They Connect
|-
|6 - Plant Spawn
|-
|7 - Ship Spawn
|-
|8 - Special Enemy

|}

STB file

2024-03-14T02:14:09Z

GameCubing8619:

{{todo|Get the info from [https://docs.google.com/document/d/1dLYlg620m1xWW-o2wl9G09ogKOrPJgMe-SiKpqe5rso this document].}}

'''STB files''' contain cutscene data in ''Pikmin 2''.

==STB File Format==

Overview:
Contains cutscene information. File may include data for spawning objects, assigning particle systems, calling animations, grabbing text ids for textboxes, transitions between scenes, rendering cutscene exclusive BMDs.

Header:
0x00 (4 char) - Magicword, “STB ”
0x04 (4 char) - BOM (FEFF), data read in big endian
0x06 (uint16) - unknown
0x08 (uint32) - size of file in bytes
0x0C (uint32) - object count
0x10 (8 char) - unknown string, “jstudio”
0X18 (uint32) - unknown
0X1C (uint32) - unknown

Objects:
JFVBFVB - Camera translations, rotation values, keyframes? And such
0x00 (8 char) - String, “JFVBFVB ”
0X08 (4 char) - BOM (FEFF), data read in big endian
0x0A (uint16) - unknown, set as 0x0100
0X0C (uint32) - size of data in subsection as bytes
0x10 (uint32) - Number of batches
0x14 (uint32) - ?
~Start of data~ (length depends on number batches and its contents)
0x18 (uint16) -
0x1A (uint16) -
0x1C (uint16) -
0x1E (uint16) -
0x20 (float32)

JCMR - JStudio Camera Manager, defines camera parameters and lengths of each cut in frame?
0x00 (4 char) - String, JCMR
0x04 (uint32) - Set to 7
0x08 (8 char) - String, camera

JMSG - JStudio Message, triggers text box messages and pulling contents from BMG by index IDs.

JACT - JStudio Actor, Cueing of animations?
JSND - JStudio Sound, Cueing of sounds? Particle emitters? Queueing of particles?

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

STB file

2024-03-14T02:13:38Z

GameCubing8619:

{{todo|Get the info from [https://docs.google.com/document/d/1dLYlg620m1xWW-o2wl9G09ogKOrPJgMe-SiKpqe5rso this document].}}

'''STB files''' contain cutscene data in ''Pikmin 2''.

STB File Format

Overview:
Contains cutscene information. File may include data for spawning objects, assigning particle systems, calling animations, grabbing text ids for textboxes, transitions between scenes, rendering cutscene exclusive BMDs.

Header:
0x00 (4 char) - Magicword, “STB ”
0x04 (4 char) - BOM (FEFF), data read in big endian
0x06 (uint16) - unknown
0x08 (uint32) - size of file in bytes
0x0C (uint32) - object count
0x10 (8 char) - unknown string, “jstudio”
0X18 (uint32) - unknown
0X1C (uint32) - unknown

Objects:
JFVBFVB - Camera translations, rotation values, keyframes? And such
0x00 (8 char) - String, “JFVBFVB ”
0X08 (4 char) - BOM (FEFF), data read in big endian
0x0A (uint16) - unknown, set as 0x0100
0X0C (uint32) - size of data in subsection as bytes
0x10 (uint32) - Number of batches
0x14 (uint32) - ?
~Start of data~ (length depends on number batches and its contents)
0x18 (uint16) -
0x1A (uint16) -
0x1C (uint16) -
0x1E (uint16) -
0x20 (float32)

JCMR - JStudio Camera Manager, defines camera parameters and lengths of each cut in frame?
0x00 (4 char) - String, JCMR
0x04 (uint32) - Set to 7
0x08 (8 char) - String, camera

JMSG - JStudio Message, triggers text box messages and pulling contents from BMG by index IDs.

JACT - JStudio Actor, Cueing of animations?
JSND - JStudio Sound, Cueing of sounds? Particle emitters? Queueing of particles?

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

Jsystem

2024-03-11T23:08:16Z

GameCubing8619:

__TOC__

==What Jsystem is==
Jsystem is a dev lib that nintendo used around the gc/wii era for devlopment before being replaced by NintendoWare toolkit later in the wiis life. and is not only used in pikmin 2 but is also used for games such as twilight princess and super mario sunshine.

== Header ==

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || char[4] || Subsystem Version || Some code for the JSYSTEM library that this file is used in, along with a version, like "J3D2" or "JPA2". Sometimes this is a generic code, like "MESG" for [[BMG]] files.
|-
| <center>0x04</center> || char[4] || File Type || The kind of file used by this subsystem, like "bmd1", "bmg1". Usually the same as the file extension of the file.
|-
| <center>0x08</center> || int || File Size || The total size of the file.
|-
| <center>0x0C</center> || int || Chunk Count || The number of "chunks" that follow.
|-
| <center>0x10</center> || char[4] || (Optional) Subversion || "SVRn" with some number might appear, or it might be 0xFF padding like below. It is ignored. It is hypothesized that this was a marker was used to track data migration during the development of the game.
|-
| <center>0x14</center> || char[12] || Padding || This was likely reserved space in case they wanted to expand the header later. It is ignored. Official files have it as 0xFF padding.
|-
|}

== Chunk Data ==

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || char[4] || Chunk Type || A FourCC code describing the contents of the chunk. This is chunk-specific.
|-
| <center>0x04</center> || int || Size || The size of the chunk, including this header. In some cases, this has been known to be off slightly and run off the end of the file. It is used to locate the next chunk.
|}

Each chunk is aligned to a 0x20 boundary, and the size is the aligned version. If the data does is not aligned to 0x20, then Nintendo's official tooling uses a custom string to fill the remaining chunk contents. The longest known version of this string is:

This is padding data to alignme

The rest of the data is file and chunk-specific. See the format's page for further information.

== Name Tables ==

Name tables are pools of strings used by multiple different JSYSTEM files, under the class name JUTNameTab. They collect all strings used in a chunk or section so that multiple references to the same string can be referenced by an index into the name table. A name table is laid out like this:

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || int || Name Count || The number of names in this Name Table.
|-
| <center>0x04</center> || JUTNameTabEntry[Count] || Entries || A variable-length set of entries.
|}

Each entry consists of the following.

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || short || Hash Code || A hash code of the string for fast lookup.
|-
| <center>0x02</center> || short || String Offset || An offset, relative to the start of the name table, containing the string contents followed by a NUL byte.
|}

= Known JSYSTEM libraries =

== JUtility ==

Utility toolkit with various bits and bobs. Contains JKernel, which are the core routines for doing I/O from disc, and memory management.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[SZS file]] || JKRDecomp || Yaz0 Compression
|-
| [[SZP file]] || JKRDecomp || Yay0 Compression
|-
| [[ARC file]] || JKRArchive || File Archive
|-
| [[BTI file]] || JUTTexture || Binary Texture Image
|-
| [[BFN file]] || JUTResFont || Binary Font
|}

== J3DGraph ==

J3DGraph is a 3D rendering library.

=== J3DGraphBase ===

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[BMD and BDL|BMD]] || J3DModelData || Binary Model
|-
| [[BMD and BDL|BDL]] || J3DModelData || Binary Display List
|-
| [[BMT]] || J3DMaterialTable || Binary Material Table
|-
| [[BLS]] || J3DClusterLoader || Binary cLuSter (Alternate vertex cluster shapes)
|}

=== J3DGraphAnimator ===

J3DGraphAnimator is a helper library that can animate various parts of J3D objects. Most animations come in two forms, "full", where each frame of an animation is serialized its entirety, and "key", where only key frames are serialized, and the runtime interpolates between key frames.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[BTK]] || J3DAnmTextureSRTKey || Texture SRT Animation (Key)
|-
| [[BCK]] || J3DAnmTransformKey || Joint Animation (Key)
|-
| [[BRK]] || J3DAnmTevRegKey || Texture Register Animation (Key)
|-
| [[BPK]] || J3DAnmColor || Color Animation (Key)
|-
| [[BTP]] || J3DAnmTexPattern || Texture Palette Animation (Full)
|-
| [[BCA]] || J3DAnmTransformFull || Joint Animation (Full)
|-
| [[BVA]] || J3DAnmVisibilityFull || Visibility Animation (Full)
|-
| [[BLA]] || J3DAnmClusterFull || Cluster Animation (Full)
|-
| [[BLK]] || J3DAnmClusterKey || Cluster Animation (Key)
|-
| ??? || J3DAnmColorFull || Color Animation (Full) (No Known Usages)
|-
| ??? || J3DAnmVtxColorFull || Vertex Color Animation (Full) (No Known Usages)
|-
| ??? || J3DAnmVtxColorKey || Vertex Color Animation (Key) (No Known Usages)
|}

== J2DGraph ==

J2DGraph is a 2D rendering and UI library.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[BLO]] || || Binary Layout
|-
| [[BMG]] || || Binary Message
|-
| [[BMC]] || || Binary Message Color (?)
|}

== JParticle ==

[[JParticle]] is a particle and effects system.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[JParticle|JPC]] || JPAEmitterArchiveLoaderDataBase || JParticle Archive
|-
| [[JParticle|JPA]] || JPAEmitterLoaderDataBase || Particle
|}

== JAudio ==

JAudio is a music and audio system, which encompasses audio and music playback.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[AAF]] || || Audio Archive File
|-
| [[BAA]] || || Binary Audio Archive
|-
| [[BMS]] || || Binary Music Sequence
|-
| [[AW]] || || Wave Archive
|}

Maybe also BAS (Binary Animation Sound)

== JStudio ==

JStudio is a cutscene recording & playback library able to sequence and play back prerecorded animations for multiple actors, objects, lights.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[STB]] || JStudio::TParse || JStudio Binary
|}

== JMap ==

JMap is a helper library for serializing map layouts. It has been seen in Luigi's Mansion and Super Mario Galaxy 1 and 2.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[BCSV]] || JMapInfo || Binary CSV, a miscellaneous serialization format.
|}

{{credits|GameCubing8619,cloudmodding}}

Main Page

2024-03-11T22:59:31Z

GameCubing8619:

{{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]]
* [[Disassembly instructions]]
* [[Jsystem]]
* [[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]]
* [[Creating Interactive BMS Files]]
* [[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 cave music|Creating randomly sequencing 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]]

Main Page

2024-03-11T22:58:20Z

GameCubing8619:

{{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]]
* [[Disassembly instructions]]
* [[Jsystem]]
* [[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]]
* [[Creating Interactive BMS Files]]
* [[Enemy Memory Usage]]
* [[Disassembly instructions]]
* [[Pikmin 2 gEnemyInfo|gEnemyInfo]]
* [[Epoch Notes]]
* [[Cubes Yap Notes]]
* [[User:Captain Salty/Blo Editing Notes|Blo Editing Notes]]
* [[Cutscene Notes]]
* [[Creating cave music|Creating randomly sequencing 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]]

Jsystem

2024-03-11T22:56:02Z

GameCubing8619:

__TOC__

==What Jsystem is==
Jsystem is a dev lib that nintendo used around the gc/wii era for devlopment before being replaced by NintendoWare toolkit later in the wiis life. and is not only used in pikmin 1 and 2 but is also used for games such as twilight princess and super mario sunshine.

== Header ==

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || char[4] || Subsystem Version || Some code for the JSYSTEM library that this file is used in, along with a version, like "J3D2" or "JPA2". Sometimes this is a generic code, like "MESG" for [[BMG]] files.
|-
| <center>0x04</center> || char[4] || File Type || The kind of file used by this subsystem, like "bmd1", "bmg1". Usually the same as the file extension of the file.
|-
| <center>0x08</center> || int || File Size || The total size of the file.
|-
| <center>0x0C</center> || int || Chunk Count || The number of "chunks" that follow.
|-
| <center>0x10</center> || char[4] || (Optional) Subversion || "SVRn" with some number might appear, or it might be 0xFF padding like below. It is ignored. It is hypothesized that this was a marker was used to track data migration during the development of the game.
|-
| <center>0x14</center> || char[12] || Padding || This was likely reserved space in case they wanted to expand the header later. It is ignored. Official files have it as 0xFF padding.
|-
|}

== Chunk Data ==

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || char[4] || Chunk Type || A FourCC code describing the contents of the chunk. This is chunk-specific.
|-
| <center>0x04</center> || int || Size || The size of the chunk, including this header. In some cases, this has been known to be off slightly and run off the end of the file. It is used to locate the next chunk.
|}

Each chunk is aligned to a 0x20 boundary, and the size is the aligned version. If the data does is not aligned to 0x20, then Nintendo's official tooling uses a custom string to fill the remaining chunk contents. The longest known version of this string is:

This is padding data to alignme

The rest of the data is file and chunk-specific. See the format's page for further information.

== Name Tables ==

Name tables are pools of strings used by multiple different JSYSTEM files, under the class name JUTNameTab. They collect all strings used in a chunk or section so that multiple references to the same string can be referenced by an index into the name table. A name table is laid out like this:

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || int || Name Count || The number of names in this Name Table.
|-
| <center>0x04</center> || JUTNameTabEntry[Count] || Entries || A variable-length set of entries.
|}

Each entry consists of the following.

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || short || Hash Code || A hash code of the string for fast lookup.
|-
| <center>0x02</center> || short || String Offset || An offset, relative to the start of the name table, containing the string contents followed by a NUL byte.
|}

= Known JSYSTEM libraries =

== JUtility ==

Utility toolkit with various bits and bobs. Contains JKernel, which are the core routines for doing I/O from disc, and memory management.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[SZS file]] || JKRDecomp || Yaz0 Compression
|-
| [[SZP file]] || JKRDecomp || Yay0 Compression
|-
| [[ARC file]] || JKRArchive || File Archive
|-
| [[BTI file]] || JUTTexture || Binary Texture Image
|-
| [[BFN file]] || JUTResFont || Binary Font
|}

== J3DGraph ==

J3DGraph is a 3D rendering library.

=== J3DGraphBase ===

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[BMD and BDL|BMD]] || J3DModelData || Binary Model
|-
| [[BMD and BDL|BDL]] || J3DModelData || Binary Display List
|-
| [[BMT]] || J3DMaterialTable || Binary Material Table
|-
| [[BLS]] || J3DClusterLoader || Binary cLuSter (Alternate vertex cluster shapes)
|}

=== J3DGraphAnimator ===

J3DGraphAnimator is a helper library that can animate various parts of J3D objects. Most animations come in two forms, "full", where each frame of an animation is serialized its entirety, and "key", where only key frames are serialized, and the runtime interpolates between key frames.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[BTK]] || J3DAnmTextureSRTKey || Texture SRT Animation (Key)
|-
| [[BCK]] || J3DAnmTransformKey || Joint Animation (Key)
|-
| [[BRK]] || J3DAnmTevRegKey || Texture Register Animation (Key)
|-
| [[BPK]] || J3DAnmColor || Color Animation (Key)
|-
| [[BTP]] || J3DAnmTexPattern || Texture Palette Animation (Full)
|-
| [[BCA]] || J3DAnmTransformFull || Joint Animation (Full)
|-
| [[BVA]] || J3DAnmVisibilityFull || Visibility Animation (Full)
|-
| [[BLA]] || J3DAnmClusterFull || Cluster Animation (Full)
|-
| [[BLK]] || J3DAnmClusterKey || Cluster Animation (Key)
|-
| ??? || J3DAnmColorFull || Color Animation (Full) (No Known Usages)
|-
| ??? || J3DAnmVtxColorFull || Vertex Color Animation (Full) (No Known Usages)
|-
| ??? || J3DAnmVtxColorKey || Vertex Color Animation (Key) (No Known Usages)
|}

== J2DGraph ==

J2DGraph is a 2D rendering and UI library.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[BLO]] || || Binary Layout
|-
| [[BMG]] || || Binary Message
|-
| [[BMC]] || || Binary Message Color (?)
|}

== JParticle ==

[[JParticle]] is a particle and effects system.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[JParticle|JPC]] || JPAEmitterArchiveLoaderDataBase || JParticle Archive
|-
| [[JParticle|JPA]] || JPAEmitterLoaderDataBase || Particle
|}

== JAudio ==

JAudio is a music and audio system, which encompasses audio and music playback.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[AAF]] || || Audio Archive File
|-
| [[BAA]] || || Binary Audio Archive
|-
| [[BMS]] || || Binary Music Sequence
|-
| [[AW]] || || Wave Archive
|}

Maybe also BAS (Binary Animation Sound)

== JStudio ==

JStudio is a cutscene recording & playback library able to sequence and play back prerecorded animations for multiple actors, objects, lights.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[STB]] || JStudio::TParse || JStudio Binary
|}

== JMap ==

JMap is a helper library for serializing map layouts. It has been seen in Luigi's Mansion and Super Mario Galaxy 1 and 2.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[BCSV]] || JMapInfo || Binary CSV, a miscellaneous serialization format.
|}

{{credits|GameCubing8619,cloudmodding}}

Jsystem

2024-03-11T22:53:42Z

GameCubing8619: /* JUtility */

__TOC__

==What Jsystem is==
Jsystem is a dev lib that nintendo used around the gc/wii era for devlopment before being replaced by NintendoWare toolkit later in the wiis life. and is not only used in pikmin 1 and 2 but is also used for games such as twilight princess and super mario sunshine.

== Header ==

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || char[4] || Subsystem Version || Some code for the JSYSTEM library that this file is used in, along with a version, like "J3D2" or "JPA2". Sometimes this is a generic code, like "MESG" for [[BMG]] files.
|-
| <center>0x04</center> || char[4] || File Type || The kind of file used by this subsystem, like "bmd1", "bmg1". Usually the same as the file extension of the file.
|-
| <center>0x08</center> || int || File Size || The total size of the file.
|-
| <center>0x0C</center> || int || Chunk Count || The number of "chunks" that follow.
|-
| <center>0x10</center> || char[4] || (Optional) Subversion || "SVRn" with some number might appear, or it might be 0xFF padding like below. It is ignored. It is hypothesized that this was a marker was used to track data migration during the development of the game.
|-
| <center>0x14</center> || char[12] || Padding || This was likely reserved space in case they wanted to expand the header later. It is ignored. Official files have it as 0xFF padding.
|-
|}

== Chunk Data ==

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || char[4] || Chunk Type || A FourCC code describing the contents of the chunk. This is chunk-specific.
|-
| <center>0x04</center> || int || Size || The size of the chunk, including this header. In some cases, this has been known to be off slightly and run off the end of the file. It is used to locate the next chunk.
|}

Each chunk is aligned to a 0x20 boundary, and the size is the aligned version. If the data does is not aligned to 0x20, then Nintendo's official tooling uses a custom string to fill the remaining chunk contents. The longest known version of this string is:

This is padding data to alignme

The rest of the data is file and chunk-specific. See the format's page for further information.

== Name Tables ==

Name tables are pools of strings used by multiple different JSYSTEM files, under the class name JUTNameTab. They collect all strings used in a chunk or section so that multiple references to the same string can be referenced by an index into the name table. A name table is laid out like this:

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || int || Name Count || The number of names in this Name Table.
|-
| <center>0x04</center> || JUTNameTabEntry[Count] || Entries || A variable-length set of entries.
|}

Each entry consists of the following.

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || short || Hash Code || A hash code of the string for fast lookup.
|-
| <center>0x02</center> || short || String Offset || An offset, relative to the start of the name table, containing the string contents followed by a NUL byte.
|}

= Known JSYSTEM libraries =

== JUtility ==

Utility toolkit with various bits and bobs. Contains JKernel, which are the core routines for doing I/O from disc, and memory management.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[szs]] || JKRDecomp || Yaz0 Compression
|-
| [[SZP]] || JKRDecomp || Yay0 Compression
|-
| [[ARC]] || JKRArchive || File Archive
|-
| [[BTI]] || JUTTexture || Binary Texture Image
|-
| [[BFN]] || JUTResFont || Binary Font
|}

== J3DGraph ==

J3DGraph is a 3D rendering library.

=== J3DGraphBase ===

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[BMD and BDL|BMD]] || J3DModelData || Binary Model
|-
| [[BMD and BDL|BDL]] || J3DModelData || Binary Display List
|-
| [[BMT]] || J3DMaterialTable || Binary Material Table
|-
| [[BLS]] || J3DClusterLoader || Binary cLuSter (Alternate vertex cluster shapes)
|}

=== J3DGraphAnimator ===

J3DGraphAnimator is a helper library that can animate various parts of J3D objects. Most animations come in two forms, "full", where each frame of an animation is serialized its entirety, and "key", where only key frames are serialized, and the runtime interpolates between key frames.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[BTK]] || J3DAnmTextureSRTKey || Texture SRT Animation (Key)
|-
| [[BCK]] || J3DAnmTransformKey || Joint Animation (Key)
|-
| [[BRK]] || J3DAnmTevRegKey || Texture Register Animation (Key)
|-
| [[BPK]] || J3DAnmColor || Color Animation (Key)
|-
| [[BTP]] || J3DAnmTexPattern || Texture Palette Animation (Full)
|-
| [[BCA]] || J3DAnmTransformFull || Joint Animation (Full)
|-
| [[BVA]] || J3DAnmVisibilityFull || Visibility Animation (Full)
|-
| [[BLA]] || J3DAnmClusterFull || Cluster Animation (Full)
|-
| [[BLK]] || J3DAnmClusterKey || Cluster Animation (Key)
|-
| ??? || J3DAnmColorFull || Color Animation (Full) (No Known Usages)
|-
| ??? || J3DAnmVtxColorFull || Vertex Color Animation (Full) (No Known Usages)
|-
| ??? || J3DAnmVtxColorKey || Vertex Color Animation (Key) (No Known Usages)
|}

== J2DGraph ==

J2DGraph is a 2D rendering and UI library.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[BLO]] || || Binary Layout
|-
| [[BMG]] || || Binary Message
|-
| [[BMC]] || || Binary Message Color (?)
|}

== JParticle ==

[[JParticle]] is a particle and effects system.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[JParticle|JPC]] || JPAEmitterArchiveLoaderDataBase || JParticle Archive
|-
| [[JParticle|JPA]] || JPAEmitterLoaderDataBase || Particle
|}

== JAudio ==

JAudio is a music and audio system, which encompasses audio and music playback.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[AAF]] || || Audio Archive File
|-
| [[BAA]] || || Binary Audio Archive
|-
| [[BMS]] || || Binary Music Sequence
|-
| [[AW]] || || Wave Archive
|}

Maybe also BAS (Binary Animation Sound)

== JStudio ==

JStudio is a cutscene recording & playback library able to sequence and play back prerecorded animations for multiple actors, objects, lights.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[STB]] || JStudio::TParse || JStudio Binary
|}

== JMap ==

JMap is a helper library for serializing map layouts. It has been seen in Luigi's Mansion and Super Mario Galaxy 1 and 2.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[BCSV]] || JMapInfo || Binary CSV, a miscellaneous serialization format.
|}

{{credits|GameCubing8619,cloudmodding}}

Jsystem

2024-03-11T22:52:56Z

GameCubing8619:

__TOC__

==What Jsystem is==
Jsystem is a dev lib that nintendo used around the gc/wii era for devlopment before being replaced by NintendoWare toolkit later in the wiis life. and is not only used in pikmin 1 and 2 but is also used for games such as twilight princess and super mario sunshine.

== Header ==

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || char[4] || Subsystem Version || Some code for the JSYSTEM library that this file is used in, along with a version, like "J3D2" or "JPA2". Sometimes this is a generic code, like "MESG" for [[BMG]] files.
|-
| <center>0x04</center> || char[4] || File Type || The kind of file used by this subsystem, like "bmd1", "bmg1". Usually the same as the file extension of the file.
|-
| <center>0x08</center> || int || File Size || The total size of the file.
|-
| <center>0x0C</center> || int || Chunk Count || The number of "chunks" that follow.
|-
| <center>0x10</center> || char[4] || (Optional) Subversion || "SVRn" with some number might appear, or it might be 0xFF padding like below. It is ignored. It is hypothesized that this was a marker was used to track data migration during the development of the game.
|-
| <center>0x14</center> || char[12] || Padding || This was likely reserved space in case they wanted to expand the header later. It is ignored. Official files have it as 0xFF padding.
|-
|}

== Chunk Data ==

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || char[4] || Chunk Type || A FourCC code describing the contents of the chunk. This is chunk-specific.
|-
| <center>0x04</center> || int || Size || The size of the chunk, including this header. In some cases, this has been known to be off slightly and run off the end of the file. It is used to locate the next chunk.
|}

Each chunk is aligned to a 0x20 boundary, and the size is the aligned version. If the data does is not aligned to 0x20, then Nintendo's official tooling uses a custom string to fill the remaining chunk contents. The longest known version of this string is:

This is padding data to alignme

The rest of the data is file and chunk-specific. See the format's page for further information.

== Name Tables ==

Name tables are pools of strings used by multiple different JSYSTEM files, under the class name JUTNameTab. They collect all strings used in a chunk or section so that multiple references to the same string can be referenced by an index into the name table. A name table is laid out like this:

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || int || Name Count || The number of names in this Name Table.
|-
| <center>0x04</center> || JUTNameTabEntry[Count] || Entries || A variable-length set of entries.
|}

Each entry consists of the following.

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || short || Hash Code || A hash code of the string for fast lookup.
|-
| <center>0x02</center> || short || String Offset || An offset, relative to the start of the name table, containing the string contents followed by a NUL byte.
|}

= Known JSYSTEM libraries =

== JUtility ==

Utility toolkit with various bits and bobs. Contains JKernel, which are the core routines for doing I/O from disc, and memory management.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[SZS]] || JKRDecomp || Yaz0 Compression
|-
| [[SZP]] || JKRDecomp || Yay0 Compression
|-
| [[ARC]] || JKRArchive || File Archive
|-
| [[BTI]] || JUTTexture || Binary Texture Image
|-
| [[BFN]] || JUTResFont || Binary Font
|}

== J3DGraph ==

J3DGraph is a 3D rendering library.

=== J3DGraphBase ===

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[BMD and BDL|BMD]] || J3DModelData || Binary Model
|-
| [[BMD and BDL|BDL]] || J3DModelData || Binary Display List
|-
| [[BMT]] || J3DMaterialTable || Binary Material Table
|-
| [[BLS]] || J3DClusterLoader || Binary cLuSter (Alternate vertex cluster shapes)
|}

=== J3DGraphAnimator ===

J3DGraphAnimator is a helper library that can animate various parts of J3D objects. Most animations come in two forms, "full", where each frame of an animation is serialized its entirety, and "key", where only key frames are serialized, and the runtime interpolates between key frames.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[BTK]] || J3DAnmTextureSRTKey || Texture SRT Animation (Key)
|-
| [[BCK]] || J3DAnmTransformKey || Joint Animation (Key)
|-
| [[BRK]] || J3DAnmTevRegKey || Texture Register Animation (Key)
|-
| [[BPK]] || J3DAnmColor || Color Animation (Key)
|-
| [[BTP]] || J3DAnmTexPattern || Texture Palette Animation (Full)
|-
| [[BCA]] || J3DAnmTransformFull || Joint Animation (Full)
|-
| [[BVA]] || J3DAnmVisibilityFull || Visibility Animation (Full)
|-
| [[BLA]] || J3DAnmClusterFull || Cluster Animation (Full)
|-
| [[BLK]] || J3DAnmClusterKey || Cluster Animation (Key)
|-
| ??? || J3DAnmColorFull || Color Animation (Full) (No Known Usages)
|-
| ??? || J3DAnmVtxColorFull || Vertex Color Animation (Full) (No Known Usages)
|-
| ??? || J3DAnmVtxColorKey || Vertex Color Animation (Key) (No Known Usages)
|}

== J2DGraph ==

J2DGraph is a 2D rendering and UI library.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[BLO]] || || Binary Layout
|-
| [[BMG]] || || Binary Message
|-
| [[BMC]] || || Binary Message Color (?)
|}

== JParticle ==

[[JParticle]] is a particle and effects system.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[JParticle|JPC]] || JPAEmitterArchiveLoaderDataBase || JParticle Archive
|-
| [[JParticle|JPA]] || JPAEmitterLoaderDataBase || Particle
|}

== JAudio ==

JAudio is a music and audio system, which encompasses audio and music playback.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[AAF]] || || Audio Archive File
|-
| [[BAA]] || || Binary Audio Archive
|-
| [[BMS]] || || Binary Music Sequence
|-
| [[AW]] || || Wave Archive
|}

Maybe also BAS (Binary Animation Sound)

== JStudio ==

JStudio is a cutscene recording & playback library able to sequence and play back prerecorded animations for multiple actors, objects, lights.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[STB]] || JStudio::TParse || JStudio Binary
|}

== JMap ==

JMap is a helper library for serializing map layouts. It has been seen in Luigi's Mansion and Super Mario Galaxy 1 and 2.

{| class="wikitable"
|-
! Extension !! JSYSTEM Class Name !! Description
|-
| [[BCSV]] || JMapInfo || Binary CSV, a miscellaneous serialization format.
|}

{{credits|GameCubing8619,cloudmodding}}

Jsystem

2024-03-11T22:24:36Z

GameCubing8619: Created page with "__TOC__ ==What Jsystem is== Jsystem is a dev lib that nintendo used around the gc/wii era for devlopment before being replaced by NintendoWare toolkit later in the wiis life...."

Disassembly instructions

2024-03-11T01:41:26Z

GameCubing8619:

The following guide will teach you how to get a disassembler environment with ''Pikmin'' or ''Pikmin 2''<nowiki>'s</nowiki> code, complete with the symbol map. Some things to keep in mind:

* The disassembly is still written in PowerPC assembly language, and we only have access to the names of functions, classes, and so on; even then, some of them might be missing. We don't have access to the names of variables or anything like that.
* The symbol map (i.e. the thing that gives functions, classes, etc. a name) for ''Pikmin 2'' can be found in the final version of the game but the demo version of the game, the one found inside of a multi-game demo disc 17. has a more complete map than final. These instructions apply to that demo. For most purposes, it's good enough, since the code should be very similar to the final game. You can apply this guide to the final version of ''Pikmin 2'', but you won't be able to get the symbol map working without a lot of effort.

== Getting the necessary files ==
=== ''Pikmin'' ===
# Obtain any copy of ''Pikmin'', as long as it's on the GameCube.
# Add it to Dolphin's game list.
# Right-click it, Properties, Filesystem:
## Right-click Disc at the top of the tree, Extract DOL..., and extract it somewhere.
## Right-click <code>/dataDir/build.map</code>, Extract File..., and extract it somewhere.

=== ''Pikmin 2'' ===
# Obtain the Multi Game Demo Disc Version 17 (US).
# Add it to Dolphin's game list.
# Right-click it, Properties, Filesystem, go down to <code>zz_Pikmin2_game.tgc</code>, right-click it, Extract File..., and extract it somewhere.
# Add the ''Pikmin 2'' demo you've extracted to Dolphin's game list.
#* If your version of Dolphin can't read .tgc files, download tgctogcm and run the .tgc file through it, in order to get a plain old .gcm file.
# Right-click the ''Pikmin 2'' demo in Dolphin's game list, Properties, Filesystem:
## Right-click Disc at the top of the tree, Extract DOL..., and extract it somewhere.
## Right-click <code>pikmin2UP.MAP</code>, Extract File..., and extract it somewhere.

== Setting up a disassembly environment ==
=== Basics ===
# Install [https://ghidra-sre.org Ghidra] (and maybe familiarize yourself with how it works).
# Go to the [https://github.com/aldelaro5/ghidra-gekko-broadway-lang Ghidra Gekko/Brodway language project], and follow the instructions to install it on Ghidra.
# Go to the [https://github.com/Cuyler36/Ghidra-GameCube-Loader Ghidra GameCube loader project], and follow the instructions to install it on Ghidra.
# In Ghidra, create a project for the game you want, and add that respective game's <code>.dol</code> file you extracted to the project. The type should be detected automatically, but if not, you should select Nintendo GameCube Binary for the format, and PowerPC:BE:32:Gekko_Brodway:default for the language.
# When asked if you want to include a symbol map, choose yes, and pick the <code>.map</code> file you extracted.
# Drag the <code>.dol</code> file to the CodeBrowser tool. When prompted to analyze the project, press Yes, and go with the defaults.

=== Details ===
==== ''Pikmin 2'' ====
# In the disassembly pane, select all with Ctrl+A.
# Right-click, Set Register Values...
# Set r2 to <code>8051e2a0</code>, and r13 to <code>8051c5c0</code>.
#* The game uses these registers a lot to load data. These values can be obtained by playing the demo in Dolphin with debug mode, pausing emulation, and examining the value of the registers, since they're always the same.

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

[[Category:Pikmin]]
[[Category:Pikmin 2]]
[[Category:Notes]]

Disassembly instructions

2024-03-11T01:40:28Z

GameCubing8619:

The following guide will teach you how to get a disassembler environment with ''Pikmin'' or ''Pikmin 2''<nowiki>'s</nowiki> code, complete with the symbol map. Some things to keep in mind:

* The disassembly is still written in PowerPC assembly language, and we only have access to the names of functions, classes, and so on; even then, some of them might be missing. We don't have access to the names of variables or anything like that.
* The symbol map (i.e. the thing that gives functions, classes, etc. a name) for ''Pikmin 2'' can be found in the final version of the game but the demo version of the game inside of a multi-game demo disc 17 has a more complete map than final. These instructions apply to that demo. For most purposes, it's good enough, since the code should be very similar to the final game. You can apply this guide to the final version of ''Pikmin 2'', but you won't be able to get the symbol map working without a lot of effort.

== Getting the necessary files ==
=== ''Pikmin'' ===
# Obtain any copy of ''Pikmin'', as long as it's on the GameCube.
# Add it to Dolphin's game list.
# Right-click it, Properties, Filesystem:
## Right-click Disc at the top of the tree, Extract DOL..., and extract it somewhere.
## Right-click <code>/dataDir/build.map</code>, Extract File..., and extract it somewhere.

=== ''Pikmin 2'' ===
# Obtain the Multi Game Demo Disc Version 17 (US).
# Add it to Dolphin's game list.
# Right-click it, Properties, Filesystem, go down to <code>zz_Pikmin2_game.tgc</code>, right-click it, Extract File..., and extract it somewhere.
# Add the ''Pikmin 2'' demo you've extracted to Dolphin's game list.
#* If your version of Dolphin can't read .tgc files, download tgctogcm and run the .tgc file through it, in order to get a plain old .gcm file.
# Right-click the ''Pikmin 2'' demo in Dolphin's game list, Properties, Filesystem:
## Right-click Disc at the top of the tree, Extract DOL..., and extract it somewhere.
## Right-click <code>pikmin2UP.MAP</code>, Extract File..., and extract it somewhere.

== Setting up a disassembly environment ==
=== Basics ===
# Install [https://ghidra-sre.org Ghidra] (and maybe familiarize yourself with how it works).
# Go to the [https://github.com/aldelaro5/ghidra-gekko-broadway-lang Ghidra Gekko/Brodway language project], and follow the instructions to install it on Ghidra.
# Go to the [https://github.com/Cuyler36/Ghidra-GameCube-Loader Ghidra GameCube loader project], and follow the instructions to install it on Ghidra.
# In Ghidra, create a project for the game you want, and add that respective game's <code>.dol</code> file you extracted to the project. The type should be detected automatically, but if not, you should select Nintendo GameCube Binary for the format, and PowerPC:BE:32:Gekko_Brodway:default for the language.
# When asked if you want to include a symbol map, choose yes, and pick the <code>.map</code> file you extracted.
# Drag the <code>.dol</code> file to the CodeBrowser tool. When prompted to analyze the project, press Yes, and go with the defaults.

=== Details ===
==== ''Pikmin 2'' ====
# In the disassembly pane, select all with Ctrl+A.
# Right-click, Set Register Values...
# Set r2 to <code>8051e2a0</code>, and r13 to <code>8051c5c0</code>.
#* The game uses these registers a lot to load data. These values can be obtained by playing the demo in Dolphin with debug mode, pausing emulation, and examining the value of the registers, since they're always the same.

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

[[Category:Pikmin]]
[[Category:Pikmin 2]]
[[Category:Notes]]

Disassembly instructions

2024-03-11T01:39:03Z

GameCubing8619:

The following guide will teach you how to get a disassembler environment with ''Pikmin'' or ''Pikmin 2''<nowiki>'s</nowiki> code, complete with the symbol map. Some things to keep in mind:

* The disassembly is still written in PowerPC assembly language, and we only have access to the names of functions, classes, and so on; even then, some of them might be missing. We don't have access to the names of variables or anything like that.
* The symbol map (i.e. the thing that gives functions, classes, etc. a name) for ''Pikmin 2'' can be found in the final version of the game, the demo version of the game inside of a multi-game demo disc. These instructions apply to that demo. For most purposes, it's good enough, since the code should be very similar to the final game. You can apply this guide to the final version of ''Pikmin 2'', but you won't be able to get the symbol map working without a lot of effort.

== Getting the necessary files ==
=== ''Pikmin'' ===
# Obtain any copy of ''Pikmin'', as long as it's on the GameCube.
# Add it to Dolphin's game list.
# Right-click it, Properties, Filesystem:
## Right-click Disc at the top of the tree, Extract DOL..., and extract it somewhere.
## Right-click <code>/dataDir/build.map</code>, Extract File..., and extract it somewhere.

=== ''Pikmin 2'' ===
# Obtain the Multi Game Demo Disc Version 17 (US).
# Add it to Dolphin's game list.
# Right-click it, Properties, Filesystem, go down to <code>zz_Pikmin2_game.tgc</code>, right-click it, Extract File..., and extract it somewhere.
# Add the ''Pikmin 2'' demo you've extracted to Dolphin's game list.
#* If your version of Dolphin can't read .tgc files, download tgctogcm and run the .tgc file through it, in order to get a plain old .gcm file.
# Right-click the ''Pikmin 2'' demo in Dolphin's game list, Properties, Filesystem:
## Right-click Disc at the top of the tree, Extract DOL..., and extract it somewhere.
## Right-click <code>pikmin2UP.MAP</code>, Extract File..., and extract it somewhere.

== Setting up a disassembly environment ==
=== Basics ===
# Install [https://ghidra-sre.org Ghidra] (and maybe familiarize yourself with how it works).
# Go to the [https://github.com/aldelaro5/ghidra-gekko-broadway-lang Ghidra Gekko/Brodway language project], and follow the instructions to install it on Ghidra.
# Go to the [https://github.com/Cuyler36/Ghidra-GameCube-Loader Ghidra GameCube loader project], and follow the instructions to install it on Ghidra.
# In Ghidra, create a project for the game you want, and add that respective game's <code>.dol</code> file you extracted to the project. The type should be detected automatically, but if not, you should select Nintendo GameCube Binary for the format, and PowerPC:BE:32:Gekko_Brodway:default for the language.
# When asked if you want to include a symbol map, choose yes, and pick the <code>.map</code> file you extracted.
# Drag the <code>.dol</code> file to the CodeBrowser tool. When prompted to analyze the project, press Yes, and go with the defaults.

=== Details ===
==== ''Pikmin 2'' ====
# In the disassembly pane, select all with Ctrl+A.
# Right-click, Set Register Values...
# Set r2 to <code>8051e2a0</code>, and r13 to <code>8051c5c0</code>.
#* The game uses these registers a lot to load data. These values can be obtained by playing the demo in Dolphin with debug mode, pausing emulation, and examining the value of the registers, since they're always the same.

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

[[Category:Pikmin]]
[[Category:Pikmin 2]]
[[Category:Notes]]

Disassembly instructions

2024-03-11T01:38:20Z

GameCubing8619:

The following guide will teach you how to get a disassembler environment with ''Pikmin'' or ''Pikmin 2''<nowiki>'s</nowiki> code, complete with the symbol map. Some things to keep in mind:

* The disassembly is still written in PowerPC assembly language, and we only have access to the names of functions, classes, and so on; even then, some of them might be missing. We don't have access to the names of variables or anything like that.
* The symbol map (i.e. the thing that gives functions, classes, etc. a name) for ''Pikmin 2'' can be found in the final a version of the game the demo version of the game inside of a multi-game demo disc. These instructions apply to that demo. For most purposes, it's good enough, since the code should be very similar to the final game. You can apply this guide to the final version of ''Pikmin 2'', but you won't be able to get the symbol map working without a lot of effort.

== Getting the necessary files ==
=== ''Pikmin'' ===
# Obtain any copy of ''Pikmin'', as long as it's on the GameCube.
# Add it to Dolphin's game list.
# Right-click it, Properties, Filesystem:
## Right-click Disc at the top of the tree, Extract DOL..., and extract it somewhere.
## Right-click <code>/dataDir/build.map</code>, Extract File..., and extract it somewhere.

=== ''Pikmin 2'' ===
# Obtain the Multi Game Demo Disc Version 17 (US).
# Add it to Dolphin's game list.
# Right-click it, Properties, Filesystem, go down to <code>zz_Pikmin2_game.tgc</code>, right-click it, Extract File..., and extract it somewhere.
# Add the ''Pikmin 2'' demo you've extracted to Dolphin's game list.
#* If your version of Dolphin can't read .tgc files, download tgctogcm and run the .tgc file through it, in order to get a plain old .gcm file.
# Right-click the ''Pikmin 2'' demo in Dolphin's game list, Properties, Filesystem:
## Right-click Disc at the top of the tree, Extract DOL..., and extract it somewhere.
## Right-click <code>pikmin2UP.MAP</code>, Extract File..., and extract it somewhere.

== Setting up a disassembly environment ==
=== Basics ===
# Install [https://ghidra-sre.org Ghidra] (and maybe familiarize yourself with how it works).
# Go to the [https://github.com/aldelaro5/ghidra-gekko-broadway-lang Ghidra Gekko/Brodway language project], and follow the instructions to install it on Ghidra.
# Go to the [https://github.com/Cuyler36/Ghidra-GameCube-Loader Ghidra GameCube loader project], and follow the instructions to install it on Ghidra.
# In Ghidra, create a project for the game you want, and add that respective game's <code>.dol</code> file you extracted to the project. The type should be detected automatically, but if not, you should select Nintendo GameCube Binary for the format, and PowerPC:BE:32:Gekko_Brodway:default for the language.
# When asked if you want to include a symbol map, choose yes, and pick the <code>.map</code> file you extracted.
# Drag the <code>.dol</code> file to the CodeBrowser tool. When prompted to analyze the project, press Yes, and go with the defaults.

=== Details ===
==== ''Pikmin 2'' ====
# In the disassembly pane, select all with Ctrl+A.
# Right-click, Set Register Values...
# Set r2 to <code>8051e2a0</code>, and r13 to <code>8051c5c0</code>.
#* The game uses these registers a lot to load data. These values can be obtained by playing the demo in Dolphin with debug mode, pausing emulation, and examining the value of the registers, since they're always the same.

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

[[Category:Pikmin]]
[[Category:Pikmin 2]]
[[Category:Notes]]

BCA file

2024-03-10T03:27:48Z

GameCubing8619: Created page with "'''BCA files''' represent model animations in ''Pikmin 2''. They are one of the two types of animation files, the other being BCK. Category:File formats Ca..."

'''BCA files''' represent model animations in ''Pikmin 2''. They are one of the two types of animation files, the other being [[BCK file|BCK]].

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

Pikmin 2 cutscene file

2024-03-09T19:30:34Z

GameCubing8619:

{{DISPLAYTITLE:''Pikmin 2'' cutscene file}}
Cutscenes in ''Pikmin 2'' are controlled by a file called <code>demo.stb</code>. This file can be found in each of the cutscene archives in <code>/user/Mukki/<name of cutscene>/demo.szs</code>. Cutscenes have predetermined number of frames.

This page describes the format of the file. The page is work in progress.

{| class="wikitable"
|+STB Header
|-
!Offset
!Type
!Description
|-
|0x0
|char[4]
|String that spells "STB", terminated by a null byte
|-
|0x4
|uint16
|Byte order mark? Always <code>0xFEFF</code>
|-
|0x6
|uint16
|Unknown. Always 0x0003?
|-
|0x8
|uint32
|Total file size
|-
|0xC
|uint32
|Amount of objects
|-
|0x10
|char[8]
|String that spells "jstudio", terminated by a null byte
|-
|0x18
|uint8[6]
|Likely 6 bytes of padding
|-
|0x1E
|int16
|Unknown. Always <code>0x04</code>?
|}

After the STB header follows object data. The following info explains that object data:

= JFVB =
JFVB is one of the possible objects that can appear in the stb file. The size of the JFVB data is usually big because it's like its own section inside the file.
For the purpose of the object count, JFVB counts as one object.
{| class="wikitable"
|+JFWB object
|-
!Offset
!Type
!Description
|-
|0x0
|uint32
|JFVB total data size (starting with 0x0 to end)
|-
|0x4
|char[4]
|String that spells "JFVB"
|-
|0x8
|FVB data
|See table below for more info
|}

{| class="wikitable"
|+FVB data
|-
!Offset
!Type
!Description
|-
|0x0
|char[4]
|String that spells "FVB", terminated by a null byte
|-
|0x4
|uint16
|Byte order mark? Always <code>0xFEFF</code>
|-
|0x6
|uint16
|Unknown, always <code>0x0100</code>?
|-
|0x8
|uint32
|FVB data size (starting with "FVB" string to end)
|-
|0xC
|uint32
|Amount of entries in FVB data entry list
|-
|0x10
|FVB data entry list
|See table below for more info
|}

{| class="wikitable"
|+FVB data entry
|-
!Offset
!Type
!Description
|-
|0x0
|uint32
|Entry size starting from 0x0 to end
|-
|0x4
|uint16
|Entry type?
|-
|0x6
|uint16
|Offset to data? Always 0
|-
|0x8
|Subentry list
|The list of subentries is terminated by a null entry (4 null bytes).
|}

FVB entry types: 1 (composite), 2 (constant), 3 (transition), 4 (list), 5 (list parameter), 6 (hermite). Only 2 and 6 are known to be used by ''Pikmin 2''.

{| class="wikitable"
|+Subentry
|-
!Offset
!Type
!Description
|-
|0x0
|uint16
|Total subentry size, starting from offset <code>0x04</code> to end
|-
|0x2
|uint16
|Subentry type
|-
|0x4
|Subentry data
|Exact data layout depends on subentry type and the type of the entry the subentry is located in
|}

Known subentry types:
* <code>0x00</code>: terminates the list of subentries
* <code>0x01</code>: If entry type is 2, one float follows. If entry type is 6, a 4 bytes integer and many floats follow. The integer is broken up like this: the first 4 bits are the width of the following float table, the remaining bits are the height. Multiply width with height to get the amount of floats that follow. Table is likely used for interpolation, possibly related to hermite interpolation.
* <code>0x12</code>: Only known to be used in entry type 6. This subentry contains two floats which specify a value range. It appears before a <code>0x01</code> subentry.

= JMSG =
This object handles the querying of messages from the BMG database and responsible for the calling message boxes onscreen. There are two segments to the JMSG objects, first is an array of message box objects, and then a control section with additional parameters. For the sake of object count, each JMSG counts as an object while the controls are independantly just one object.
{| class="wikitable"
|+JMSG object
|-
!Offset
!Type
!Description
|-
|0x0
|uint32
|Size of section in bytes
|-
|0x4
|char[4]
|String that spells "JMSG"
|-
|0x8
|uint32
|If this is the first message box this is set to <code>0x0000000B</code>, else <code>0x0000000C</code>
|-
|0xC
|10 bytes
|A string in Shift-JIS Romaji, "メッセージ", or "Message" in English
|-
|0x16
|uint16
|{{unsure|Unknown identifer?}}
|-
|0x18
|uint16
|An identifer? Value is always <code>0x0200</code>
|-
|0x1A
|uint16
|Value represents what frame to pause the cutscene and display the message box onscreen
|-
|0x1C
|8 Bytes
|Value doesn't appear to change, always <code>0x8000000800040859</code>
|-
|0x24
|uint32
|ID of message
|-
|0x28
|uint16
|Same as value from 0x14. Always <code>0x0200</code>
|-
|0x2A
|uint16
|Always <code>0x0001</code>
|-
|0x2C
|uint16
|Padding of <code>0x00</code>'s, end of section
|}

{| class="wikitable"
|+JMSG controls section
|-
!Offset
!Type
!Description
|-
|0x0
|uint32
|Size of section in bytes
|-
|0x4
|uint32
|Padding of <code>0xFF</code>'s
|-
|0x8
|uint32
|Unknown, set to <code>0x0000000D</code>
|-
|0xC
|12 bytes
|A string in Shift-JIS Romaji, "コントロール", or "Control" in English
|-
|0x18
|uint32
|Padding of <code>0x00</code>'s
|-
|0x1C
|12 Bytes
|Start of control values for the JMSG object
|-
|0x28*
|uint32
|Padding of <code>0x00</code>'s, end of section
|}

∗ Ending offset differs depending on the amount of JMSG objects there are since each object gets its own 12 bytes of control values.

= JCMR =
Object that deals with the camera movement.
{| class="wikitable"
|+JCMR object
|-
!Offset
!Type
!Description
|-
|0x0
|uint32
|Size of section in bytes
|-
|0x4
|char[4]
|String that spells "JACT"
|-
|0x8
|uint32
|Length of object name.
|-
|0xC
|char[length]
|Object name
|-
|0xC+length rounded up to multiple of 4
|JCMR data entries
|See below
|}

{| class="wikitable"
|+JCMR data entry
|-
!Offset
!Type
!Description
|-
|0x0
|uint32
|If equal to 0, terminates list of data entries and no further JCMR data follows. Otherwise equal to 0x8000003C
|-
|0x4
|0x40 bytes of data
|Only exists if previous value was 0x8000003C, purpose unknown
|}

= JACT =
{| class="wikitable"
|+JACT object
|-
!Offset
!Type
!Description
|-
|0x0
|uint32
|Size of section in bytes
|-
|0x4
|char[4]
|String that spells "JACT"
|-
|0x8
|uint32
|Length of object name.
|-
|0xC
|char[length]
|Object name
|-
|0xC+length rounded up to multiple of 4
|JACT data
|unknown
|}
The first character in the name of a JACT object has a meaning: "+" means special actor, "@" means particle actor, "*" means creature.

= JSND =

still being looked into atm but is suspected to be for music

= JCNT =

have no idea but i suspect that it either does nothing or is for the frames in a cutscene- Cube 2024

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

Pikmin 2 cutscene file

2024-03-09T19:29:55Z

GameCubing8619:

{{DISPLAYTITLE:''Pikmin 2'' cutscene file}}
Cutscenes in ''Pikmin 2'' are controlled by a file called <code>demo.stb</code>. This file can be found in each of the cutscene archives in <code>/user/Mukki/<name of cutscene>/demo.szs</code>. Cutscenes have predetermined number of frames.

This page describes the format of the file. The page is work in progress.

{| class="wikitable"
|+STB Header
|-
!Offset
!Type
!Description
|-
|0x0
|char[4]
|String that spells "STB", terminated by a null byte
|-
|0x4
|uint16
|Byte order mark? Always <code>0xFEFF</code>
|-
|0x6
|uint16
|Unknown. Always 0x0003?
|-
|0x8
|uint32
|Total file size
|-
|0xC
|uint32
|Amount of objects
|-
|0x10
|char[8]
|String that spells "jstudio", terminated by a null byte
|-
|0x18
|uint8[6]
|Likely 6 bytes of padding
|-
|0x1E
|int16
|Unknown. Always <code>0x04</code>?
|}

After the STB header follows object data. The following info explains that object data:

= JFVB =
JFVB is one of the possible objects that can appear in the stb file. The size of the JFVB data is usually big because it's like its own section inside the file.
For the purpose of the object count, JFVB counts as one object.
{| class="wikitable"
|+JFWB object
|-
!Offset
!Type
!Description
|-
|0x0
|uint32
|JFVB total data size (starting with 0x0 to end)
|-
|0x4
|char[4]
|String that spells "JFVB"
|-
|0x8
|FVB data
|See table below for more info
|}

{| class="wikitable"
|+FVB data
|-
!Offset
!Type
!Description
|-
|0x0
|char[4]
|String that spells "FVB", terminated by a null byte
|-
|0x4
|uint16
|Byte order mark? Always <code>0xFEFF</code>
|-
|0x6
|uint16
|Unknown, always <code>0x0100</code>?
|-
|0x8
|uint32
|FVB data size (starting with "FVB" string to end)
|-
|0xC
|uint32
|Amount of entries in FVB data entry list
|-
|0x10
|FVB data entry list
|See table below for more info
|}

{| class="wikitable"
|+FVB data entry
|-
!Offset
!Type
!Description
|-
|0x0
|uint32
|Entry size starting from 0x0 to end
|-
|0x4
|uint16
|Entry type?
|-
|0x6
|uint16
|Offset to data? Always 0
|-
|0x8
|Subentry list
|The list of subentries is terminated by a null entry (4 null bytes).
|}

FVB entry types: 1 (composite), 2 (constant), 3 (transition), 4 (list), 5 (list parameter), 6 (hermite). Only 2 and 6 are known to be used by ''Pikmin 2''.

{| class="wikitable"
|+Subentry
|-
!Offset
!Type
!Description
|-
|0x0
|uint16
|Total subentry size, starting from offset <code>0x04</code> to end
|-
|0x2
|uint16
|Subentry type
|-
|0x4
|Subentry data
|Exact data layout depends on subentry type and the type of the entry the subentry is located in
|}

Known subentry types:
* <code>0x00</code>: terminates the list of subentries
* <code>0x01</code>: If entry type is 2, one float follows. If entry type is 6, a 4 bytes integer and many floats follow. The integer is broken up like this: the first 4 bits are the width of the following float table, the remaining bits are the height. Multiply width with height to get the amount of floats that follow. Table is likely used for interpolation, possibly related to hermite interpolation.
* <code>0x12</code>: Only known to be used in entry type 6. This subentry contains two floats which specify a value range. It appears before a <code>0x01</code> subentry.

= JMSG =
This object handles the querying of messages from the BMG database and responsible for the calling message boxes onscreen. There are two segments to the JMSG objects, first is an array of message box objects, and then a control section with additional parameters. For the sake of object count, each JMSG counts as an object while the controls are independantly just one object.
{| class="wikitable"
|+JMSG object
|-
!Offset
!Type
!Description
|-
|0x0
|uint32
|Size of section in bytes
|-
|0x4
|char[4]
|String that spells "JMSG"
|-
|0x8
|uint32
|If this is the first message box this is set to <code>0x0000000B</code>, else <code>0x0000000C</code>
|-
|0xC
|10 bytes
|A string in Shift-JIS Romaji, "メッセージ", or "Message" in English
|-
|0x16
|uint16
|{{unsure|Unknown identifer?}}
|-
|0x18
|uint16
|An identifer? Value is always <code>0x0200</code>
|-
|0x1A
|uint16
|Value represents what frame to pause the cutscene and display the message box onscreen
|-
|0x1C
|8 Bytes
|Value doesn't appear to change, always <code>0x8000000800040859</code>
|-
|0x24
|uint32
|ID of message
|-
|0x28
|uint16
|Same as value from 0x14. Always <code>0x0200</code>
|-
|0x2A
|uint16
|Always <code>0x0001</code>
|-
|0x2C
|uint16
|Padding of <code>0x00</code>'s, end of section
|}

{| class="wikitable"
|+JMSG controls section
|-
!Offset
!Type
!Description
|-
|0x0
|uint32
|Size of section in bytes
|-
|0x4
|uint32
|Padding of <code>0xFF</code>'s
|-
|0x8
|uint32
|Unknown, set to <code>0x0000000D</code>
|-
|0xC
|12 bytes
|A string in Shift-JIS Romaji, "コントロール", or "Control" in English
|-
|0x18
|uint32
|Padding of <code>0x00</code>'s
|-
|0x1C
|12 Bytes
|Start of control values for the JMSG object
|-
|0x28*
|uint32
|Padding of <code>0x00</code>'s, end of section
|}

∗ Ending offset differs depending on the amount of JMSG objects there are since each object gets its own 12 bytes of control values.

= JCMR =
Object that deals with the camera movement.
{| class="wikitable"
|+JCMR object
|-
!Offset
!Type
!Description
|-
|0x0
|uint32
|Size of section in bytes
|-
|0x4
|char[4]
|String that spells "JACT"
|-
|0x8
|uint32
|Length of object name.
|-
|0xC
|char[length]
|Object name
|-
|0xC+length rounded up to multiple of 4
|JCMR data entries
|See below
|}

{| class="wikitable"
|+JCMR data entry
|-
!Offset
!Type
!Description
|-
|0x0
|uint32
|If equal to 0, terminates list of data entries and no further JCMR data follows. Otherwise equal to 0x8000003C
|-
|0x4
|0x40 bytes of data
|Only exists if previous value was 0x8000003C, purpose unknown
|}

= JACT =
{| class="wikitable"
|+JACT object
|-
!Offset
!Type
!Description
|-
|0x0
|uint32
|Size of section in bytes
|-
|0x4
|char[4]
|String that spells "JACT"
|-
|0x8
|uint32
|Length of object name.
|-
|0xC
|char[length]
|Object name
|-
|0xC+length rounded up to multiple of 4
|JACT data
|unknown
|}
The first character in the name of a JACT object has a meaning: "+" means special actor, "@" means particle actor, "*" means creature.

= JSND =

still being looked into atm but is suspected to be for music

= JCNT =

have no idea but i suspect that it either does nothing or is for the frames in a cutscene-cube

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

Pikmin 2 cutscene file

2024-03-09T19:11:43Z

GameCubing8619:

Pikmin 2 cutscene file

2024-03-09T19:10:44Z

GameCubing8619:

{{DISPLAYTITLE:''Pikmin 2'' cutscene file}}
Cutscenes in ''Pikmin 2'' are controlled by a file called <code>demo.stb</code>. This file can be found in each of the cutscene archives in <code>/user/Mukki/<name of cutscene>/demo.szs</code>. Cutscenes have predetermined number of frames.

This page describes the format of the file. The page is work in progress.

{| class="wikitable"
|+STB Header
|-
!Offset
!Type
!Description
|-
|0x0
|char[4]
|String that spells "STB", terminated by a null byte
|-
|0x4
|uint16
|Byte order mark? Always <code>0xFEFF</code>
|-
|0x6
|uint16
|Unknown. Always 0x0003?
|-
|0x8
|uint32
|Total file size
|-
|0xC
|uint32
|Amount of objects
|-
|0x10
|char[8]
|String that spells "jstudio", terminated by a null byte
|-
|0x18
|uint8[6]
|Likely 6 bytes of padding
|-
|0x1E
|int16
|Unknown. Always <code>0x04</code>?
|}

After the STB header follows object data. The following info explains that object data:

= JFVB =
JFVB is one of the possible objects that can appear in the stb file. The size of the JFVB data is usually big because it's like its own section inside the file.
For the purpose of the object count, JFVB counts as one object.
{| class="wikitable"
|+JFWB object
|-
!Offset
!Type
!Description
|-
|0x0
|uint32
|JFVB total data size (starting with 0x0 to end)
|-
|0x4
|char[4]
|String that spells "JFVB"
|-
|0x8
|FVB data
|See table below for more info
|}

{| class="wikitable"
|+FVB data
|-
!Offset
!Type
!Description
|-
|0x0
|char[4]
|String that spells "FVB", terminated by a null byte
|-
|0x4
|uint16
|Byte order mark? Always <code>0xFEFF</code>
|-
|0x6
|uint16
|Unknown, always <code>0x0100</code>?
|-
|0x8
|uint32
|FVB data size (starting with "FVB" string to end)
|-
|0xC
|uint32
|Amount of entries in FVB data entry list
|-
|0x10
|FVB data entry list
|See table below for more info
|}

{| class="wikitable"
|+FVB data entry
|-
!Offset
!Type
!Description
|-
|0x0
|uint32
|Entry size starting from 0x0 to end
|-
|0x4
|uint16
|Entry type?
|-
|0x6
|uint16
|Offset to data? Always 0
|-
|0x8
|Subentry list
|The list of subentries is terminated by a null entry (4 null bytes).
|}

FVB entry types: 1 (composite), 2 (constant), 3 (transition), 4 (list), 5 (list parameter), 6 (hermite). Only 2 and 6 are known to be used by ''Pikmin 2''.

{| class="wikitable"
|+Subentry
|-
!Offset
!Type
!Description
|-
|0x0
|uint16
|Total subentry size, starting from offset <code>0x04</code> to end
|-
|0x2
|uint16
|Subentry type
|-
|0x4
|Subentry data
|Exact data layout depends on subentry type and the type of the entry the subentry is located in
|}

Known subentry types:
* <code>0x00</code>: terminates the list of subentries
* <code>0x01</code>: If entry type is 2, one float follows. If entry type is 6, a 4 bytes integer and many floats follow. The integer is broken up like this: the first 4 bits are the width of the following float table, the remaining bits are the height. Multiply width with height to get the amount of floats that follow. Table is likely used for interpolation, possibly related to hermite interpolation.
* <code>0x12</code>: Only known to be used in entry type 6. This subentry contains two floats which specify a value range. It appears before a <code>0x01</code> subentry.

= JMSG =
This object handles the querying of messages from the BMG database and responsible for the calling message boxes onscreen. There are two segments to the JMSG objects, first is an array of message box objects, and then a control section with additional parameters. For the sake of object count, each JMSG counts as an object while the controls are independantly just one object.
{| class="wikitable"
|+JMSG object
|-
!Offset
!Type
!Description
|-
|0x0
|uint32
|Size of section in bytes
|-
|0x4
|char[4]
|String that spells "JMSG"
|-
|0x8
|uint32
|If this is the first message box this is set to <code>0x0000000B</code>, else <code>0x0000000C</code>
|-
|0xC
|10 bytes
|A string in Shift-JIS Romaji, "メッセージ", or "Message" in English
|-
|0x16
|uint16
|{{unsure|Unknown identifer?}}
|-
|0x18
|uint16
|An identifer? Value is always <code>0x0200</code>
|-
|0x1A
|uint16
|Value represents what frame to pause the cutscene and display the message box onscreen
|-
|0x1C
|8 Bytes
|Value doesn't appear to change, always <code>0x8000000800040859</code>
|-
|0x24
|uint32
|ID of message
|-
|0x28
|uint16
|Same as value from 0x14. Always <code>0x0200</code>
|-
|0x2A
|uint16
|Always <code>0x0001</code>
|-
|0x2C
|uint16
|Padding of <code>0x00</code>'s, end of section
|}

{| class="wikitable"
|+JMSG controls section
|-
!Offset
!Type
!Description
|-
|0x0
|uint32
|Size of section in bytes
|-
|0x4
|uint32
|Padding of <code>0xFF</code>'s
|-
|0x8
|uint32
|Unknown, set to <code>0x0000000D</code>
|-
|0xC
|12 bytes
|A string in Shift-JIS Romaji, "コントロール", or "Control" in English
|-
|0x18
|uint32
|Padding of <code>0x00</code>'s
|-
|0x1C
|12 Bytes
|Start of control values for the JMSG object
|-
|0x28*
|uint32
|Padding of <code>0x00</code>'s, end of section
|}

∗ Ending offset differs depending on the amount of JMSG objects there are since each object gets its own 12 bytes of control values.

= JCMR =
Object that deals with the camera movement.
{| class="wikitable"
|+JCMR object
|-
!Offset
!Type
!Description
|-
|0x0
|uint32
|Size of section in bytes
|-
|0x4
|char[4]
|String that spells "JACT"
|-
|0x8
|uint32
|Length of object name.
|-
|0xC
|char[length]
|Object name
|-
|0xC+length rounded up to multiple of 4
|JCMR data entries
|See below
|}

{| class="wikitable"
|+JCMR data entry
|-
!Offset
!Type
!Description
|-
|0x0
|uint32
|If equal to 0, terminates list of data entries and no further JCMR data follows. Otherwise equal to 0x8000003C
|-
|0x4
|0x40 bytes of data
|Only exists if previous value was 0x8000003C, purpose unknown
|}

= JACT =
{| class="wikitable"
|+JACT object
|-
!Offset
!Type
!Description
|-
|0x0
|uint32
|Size of section in bytes
|-
|0x4
|char[4]
|String that spells "JACT"
|-
|0x8
|uint32
|Length of object name.
|-
|0xC
|char[length]
|Object name
|-
|0xC+length rounded up to multiple of 4
|JACT data
|unknown
|}

= JSND =

still being looked into atm but is suspected to be for music

The first character in the name of a JACT object has a meaning: "+" means special actor, "@" means particle actor, "*" means creature.

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

Submerged Castle oddities

2024-03-09T04:08:12Z

GameCubing8619:

The Submerged Castle, known internally as <code>yakushima_4</code>, has a number of hardcoded oddities that allow it to work. They are important to remember when editing the Submerged Castle, or making caves that are similar to it, and are documented here.

== Blue Pikmin Only ==
The most commonly known oddity of the Submerged Castle is that non-Blues cannot enter it, even through hacking. One of the entries in the Perplexing Pool's <code>initgen.txt</code> file is commented with <code>for yakushima_4</code>, and the entry itself has code related to Blue Pikmin.

The lock is accomplished by checking Pikmin type and cave ID; these factors can be modified by DOL editing.

== Music ==
In <code>/root/user/Totaka</code>, there is a set of text files that determine the music that plays in each cave. The Submerged Castle is set to play <code>new_01_0.cnd</code> on every sublevel. Normally, this is the theme that plays on sublevel 6 of the Hole of Heroes, but when set to play in this cave, it plays the normal theme. what we know is that new_01_0.cnd is used as a placeholder at times and that kuropre.bms is hardcoded to play on the submerged castle

The music that plays when facing the Waterwraith is odd, too. If encountered in this cave, its theme(s) will play, but not if it's encountered anywhere else. This probably allows the Bully Den's music selection to work properly.

== Waterwraith oddities ==
Normally, when the Waterwraith spawns via its <code>BlackManTimer</code> reaching 0 for the first time, a cutscene will play acknowledging so. However, the cutscene will only play if the Waterwraith is in the Submerged Castle. In any other location, this will not happen, similarly to the music oddities above. Once again, this probably allows the Bully Den to work properly.

== Spawning ==
In the first four sublevels, the Waterwraith will spawn once the <code>BlackManTimer</code> reaches 0 (set to 300 which is 5 minutes). However, even though the <code>BlackManTimer</code> is present on the final sublevel (it is set to 15 seconds), the Waterwraith will not spawn until the player or a Pikmin reaches the center of the arena (where the egg is located). It is currently unknown how this is achieved and the <code>a attribute</code> setting (which is on 2 for all of Submerged Castle) doesn't seem to be a contributing factor.

The Waterwraith is hardcoded to act differently in the final floor of a dungeon.

== Other ==
Similarly to the Subterranean Complex, the Violet Candypop buds on sublevel 5 will always be there, regardless of how many Purple Pikmin you have in the ship. This is preventing you from not being able to defeat the Waterwraith. Although there are only 2 and they're considerably harder to get to, you can throw the cave's Bulbmin into the flowers, preventing you from sacrificing 80 non-Bulbmin to them instead. It's a great alternative method to raise Purple Numbers so you can lift the Doomsday Apparatus.

[[Category:Pikmin 2]]
[[Category:Notes]]

BTI file

2024-03-09T03:56:53Z

GameCubing8619:

'''BTI''' is an image file format similar to [[TEX0]], [[TPL]] and [[BREFT]] file formats. The only difference is the file header.

__TOC__

== File Format ==
The file format is very simple and starts with a file header followed by the image data. All data is written in [[big endian]].

=== File Header ===
The following table shows the file header. It is 0x20 bytes long. There is no magic to identify BTI files,
so tools may do some plausibility checks to identify them.

{| class="wikitable"
|+ File Header
|-
! Offset !! Type !! Description
|-
| 0x00 || Byte || '''[[Image Formats|Image format]]'''.
|-
| 0x01 || Byte || '''Enable alpha''' (0x00 means alpha is disabled, anything higher means alpha is enabled).
|-
| 0x02 || UInt16 || '''Width''' of the image in pixels.
|-
| 0x04 || UInt16 || '''Height''' of the image in pixels.
|-
| 0x06 || Byte || '''Wrap S'''[http://www.amnoid.de/gc/bti.txt] (0x01 for posteffect.bti, 0x00 for others). Probably repeat, clamp or mirror wraps for U projection maps.
|-
| 0x07 || Byte || '''Wrap T'''[http://www.amnoid.de/gc/bti.txt] (0x01 for posteffect.bti, 0x00 for others). Probably repeat, clamp or mirror wraps for V projection maps.
|-
| 0x08 || UInt16 || '''[[Image Formats#Palette_Formats|Palette format]]''' (not used in [[Mario Kart Wii]]).
|-
| 0x0A || UInt16 || '''Number of palette entries'''.
|-
| 0x0C || UInt32 || '''Offset to [[#Image and Palette Data|palette data]]''', relative to the start of the file header.
|-
| 0x10 || UInt32 || {{Unknown-left|'''Unknown'''.}} Always 0 in [[Mario Kart Wii]].
|-
| 0x14 || Byte || '''Magnification filter type''' (0x00 means nearest, 0x01 means linear).
|-
| 0x15 || Byte || '''Minification filter type'''.
|-
| 0x16 || UInt16 || {{Unknown-left|'''Unknown'''.}} Always 0 in [[Mario Kart Wii]].
|-
| 0x18 || Byte || '''Total number of images''', thus number of mipmaps + 1.
|-
| 0x19 || Byte || {{Unknown-left|'''Unknown'''.}} Always 0 in [[Mario Kart Wii]].
|-
| 0x1A || UInt16 || {{Unknown-left|'''Unknown'''.}} Always 0 in [[Mario Kart Wii]].
|-
| 0x1C || UInt32 || '''Offset to [[#Image and Palette Data|image data]]''', relative to the start of the file header.
|-
| 0x20 || colspan=2 {{unknown|End of file header}}
|}

=== Image and Palette Data ===
The image and palette data starts at the given data offset in the file header.
The data depends on the image and palette formats format.
The image format values are listed below.

{{Credits|Gamecubing8619,Vulcan,wiki.tockdom.com}}

BTI file

2024-03-09T03:56:22Z

GameCubing8619: /* Image and Palette Data */

'''BTI''' is an image file format similar to [[TEX0]], [[TPL]] and [[BREFT]] file formats. The only difference is the file header.

__TOC__

== Appearance in Mario Kart Wii ==
BTI files are used rarely in [[Mario Kart Wii]]. They can be found in some tracks with 3 different file names:
* [http://szs.wiimm.de/cgi/mkw/track-ref/course.btienv#info course.btiEnv]
* [http://szs.wiimm.de/cgi/mkw/track-ref/course.btimat#info course.btiMat]
* [http://szs.wiimm.de/cgi/mkw/track-ref/posteffect/posteffect.bti#info posteffect/posteffect.bti]

== File Format ==
The file format is very simple and starts with a file header followed by the image data. All data is written in [[big endian]].

=== File Header ===
The following table shows the file header. It is 0x20 bytes long. There is no magic to identify BTI files,
so tools may do some plausibility checks to identify them.

{| class="wikitable"
|+ File Header
|-
! Offset !! Type !! Description
|-
| 0x00 || Byte || '''[[Image Formats|Image format]]'''.
|-
| 0x01 || Byte || '''Enable alpha''' (0x00 means alpha is disabled, anything higher means alpha is enabled).
|-
| 0x02 || UInt16 || '''Width''' of the image in pixels.
|-
| 0x04 || UInt16 || '''Height''' of the image in pixels.
|-
| 0x06 || Byte || '''Wrap S'''[http://www.amnoid.de/gc/bti.txt] (0x01 for posteffect.bti, 0x00 for others). Probably repeat, clamp or mirror wraps for U projection maps.
|-
| 0x07 || Byte || '''Wrap T'''[http://www.amnoid.de/gc/bti.txt] (0x01 for posteffect.bti, 0x00 for others). Probably repeat, clamp or mirror wraps for V projection maps.
|-
| 0x08 || UInt16 || '''[[Image Formats#Palette_Formats|Palette format]]''' (not used in [[Mario Kart Wii]]).
|-
| 0x0A || UInt16 || '''Number of palette entries'''.
|-
| 0x0C || UInt32 || '''Offset to [[#Image and Palette Data|palette data]]''', relative to the start of the file header.
|-
| 0x10 || UInt32 || {{Unknown-left|'''Unknown'''.}} Always 0 in [[Mario Kart Wii]].
|-
| 0x14 || Byte || '''Magnification filter type''' (0x00 means nearest, 0x01 means linear).
|-
| 0x15 || Byte || '''Minification filter type'''.
|-
| 0x16 || UInt16 || {{Unknown-left|'''Unknown'''.}} Always 0 in [[Mario Kart Wii]].
|-
| 0x18 || Byte || '''Total number of images''', thus number of mipmaps + 1.
|-
| 0x19 || Byte || {{Unknown-left|'''Unknown'''.}} Always 0 in [[Mario Kart Wii]].
|-
| 0x1A || UInt16 || {{Unknown-left|'''Unknown'''.}} Always 0 in [[Mario Kart Wii]].
|-
| 0x1C || UInt32 || '''Offset to [[#Image and Palette Data|image data]]''', relative to the start of the file header.
|-
| 0x20 || colspan=2 {{unknown|End of file header}}
|}

=== Image and Palette Data ===
The image and palette data starts at the given data offset in the file header.
The data depends on the image and palette formats format.
The image format values are listed below.

{{Credits|Gamecubing8619,Vulcan,wiki.tockdom.com}}

BTI file

2024-03-09T03:55:53Z

GameCubing8619:

Pikmin 2 collinfo.txt

2024-03-09T03:49:01Z

GameCubing8619: /* Format */

Pikmin 2 collinfo.txt

2024-03-09T03:18:01Z

GameCubing8619: /* Format */

__TOC__

==What Collinfo Is==
within user\Abe\Pellet\us\otakara_texts.szs there are multiple folders each for a different treasure and inside of each treasure folder there is a animmgr.txt for aminations and a collinfo for collision which we will go in depth here.

==Format==
{| class="wikitable sortable"
! Property || Description
|-
| <code>child count</code>
| The internal name of the treasure (used when spawning treasures in caves).
|-
| <code>radius</code>
| Name of the <code>.szs</code> archive containing the model, in </code>/user/Abe/pellet/region</code>.
|-
| <code>id</code>
| Name of the [[BMD file|<code>.bmd</code> model]] within the <code>.szs</code> archive.
|-
| <code>code</code>
| File name of the animation manager in <code>otakara_texts.szs</code>.
|-
| <code>offset</code>
| Name of the collision text file in <code>otakara_texts.szs</code>.
|-
| <code>joint index</code>
| {{unsure|Collision processing radius?}}
|-
| <code>attribute</code>
| Radius of shadow and where Pikmin pick up the treasure base.
|}

{|class="wikitable sortable mw-collapsible"
! collinfo.txt example
<div align="left"><source>
1 # child count
19.143629 # radius
{none} # id
{____} # code
0.000000 -2.000000 -1.000000 # offset
0 # joint index
0 # attribute
# child
{
0 # child count
19.143629 # radius
{none} # id
{____} # code
0.000000 -2.000000 -1.000000 # offset
0 # joint index
0 # attribute
}
</source></div>
|}

{{credits|GameCubing8619}}