Pikmin Technical Knowledge Base - User contributions [en]

Olimar's voyage log table

2026-01-20T01:38:35Z

Iwillremembermypasswordthistime: wii changed a flag

{{todo|Get either images or the actual text for each log, so its clear what they refer to. Also probably better formatting from someone good at it.}}

This is a table in the game's code that dictates how the end of day logs work in ''Pikmin''. In the event that conditions for multiple are met in a day, this table determines which one takes priority. It also determines if a log that is triggered, but not viewed on the same day should be forgotten, kept, or reset.

__TOC__

==Value explanations==
The <code>resultsFlags</code> table is an array of 75 entries, for every possible log, including unused ones.

# The first value, the index, is the ID of the BLO file to open for this log. You will notice some are skipped, either for unused BLO files or logs that consist of multiple BLO files.
# Next is a flag that dictates if the log should be enabled every day by default. This is used for all of Olimar's "nothing" logs that appear when he has nothing specific to write about.
# The third value is the log's priority. In the event multiple logs are met in a day, the one with the lowest priority value will be seen.
# The final value determines what to do if the log's condition is met, but it is not seen on the same day. 0 means that the log will be forgotten forever, 1 means it will be reset so it could be triggered again on a later day. 2 means it will remain in the queue and will be used as soon as nothing with higher priority is used over it.

For example, the log about Olimar being KO'd has very high priority, since if that happened, Olimar would definitely be writing about it right away. But if it were to get skipped that day anyway, its store value is set to 1, so it will be reset and could be triggered on a later day.

Once a log has been used, it can never be used again, regardless of any values in its table.

Lastly, this table also includes what events trigger a log to be viewable that day. Some are very self-explanatory, others not so much. It also has conditions that can force a log to be dropped, even if it was triggered that day.

For example, when Yellow Pikmin are gotten, a log is set about how Olimar has found Yellow Pikmin, but does not know about bomb rocks yet. Once a bomb rock is used, that log is cancelled and killed permanently, and the version where he does know about bomb rocks is put in instead. Once a log has been cancelled, it can never be seen. Same goes for a log with store type 0 that isn't seen on the day it's triggered. This is why some logs are very uncommon to actually see, especially for the bosses.

==Table==
{| class="wikitable sortable"
! Description || BLO index || Auto-enabled || Priority || Store type || Trigger || Trigger cancel || Notes
|-
| End of day 1 || 1 || No || 1 || Forget || Set on at the end of day 1 || N/A || Lowest priority in the game since its obviously important.
|-
| First Visit Forest of Hope || 3 || No || 3 || Forget || Set on ending day while in Forest of Hope || N/A ||
|-
| Forest Navel Opened || 5 || No || 9 || Forget || Set the moment Forest Navel is unlocked || N/A ||
|-
| First Visit Forest Navel || 6 || No || 10 || Forget || Set on ending day while in Forest Navel || N/A ||
|-
| Distant Spring Opened || 7 || No || 11 || Forget || Set the moment Distant Spring is unlocked || N/A ||
|-
| First Visit Distant Spring || 8 || No || 12 || Reset || Set on ending day while in Distant Spring || N/A ||
|-
| Final Day || 10 || No || 13 || Forget || Set on at end of day 29 || N/A ||
|-
| 25 Parts || 11 || No || 14 || Forget || Set on when player has exactly 25 parts || Unset when player has 29 parts ||
|-
| 29 Parts || 12 || No || 15 || Forget || Set on when player has exactly 29 parts || N/A || Effectively also when Final Trial is unlocked.
|-
| Olimar Killed || 13 || No || 5 || Reset || Set upon Olimar entering the Dead state || N/A ||
|-
| Pikmin Extinction || 14 || No || 4 || Reset || Set upon entering the extinction state || N/A ||
|-
| Has all 30 parts || 15 || No || 2 || Reset || N/A || N/A || Unused log meant for the good ending, has high priority but never actually enabled. Not that it would matter since there is no log at this point.
|-
| Yellow Pikmin with Bomb || 17 || No || 6 || Reset || Set upon a yellow picking up a Bomb Rock || N/A ||
|-
| Meeting Blue Pikmin || 18 || No || 7 || Forget || Set upon plucking the first Blue || N/A ||
|-
| Pikmin Routing || 19 || No || 16 || Keep || N/A || N/A || An unused log about Pikmin pathfinding, dropped via having no trigger. Probably due to not being too noteworthy.
|-
| Olimar's Daydream || 20 || No || 19 || Reset || Set on starting day 10 || Unset starting on day 20 || Might as well be a nothing log, but has these requirements for some reason.
|-
| 15 Parts || 21 || No || 20 || Reset || Set when the player has 15 or more parts || Unset when at 25 or 29 parts ||
|-
| Pikmin left behind || 23 || No || 8 || Reset || Set if a Pikmin is left behind today || N/A ||
|-
| Pikmin dies to Bomb Rock || 24 || No || 17 || Reset || Set upon a Pikmin dying to an explosion || N/A ||
|-
| 10 Parts || 26 || No || 18 || Keep || Set if at over 10 parts and past day 8 || N/A ||
|-
| Unused Controls Log 1 || 27 || Yes || 200 || Keep || N/A || Unset upon starting a file || First of multiple unused and untranslated logs, this one uses a controller image.
|-
| Unused Controls Log 2 || 29 || No || 201 || Keep || Set on at end of day 1 || Unset upon starting a file || This one is still enabled, but it's killed upon starting a file anyway, so it doesn't matter.
|-
| Unused Controls Pikmin Log || 31 || Yes || 202 || Keep || N/A || Unset upon starting a file || Unused again, seems to be related to Pikmin turning pale.
|-
| Broken Bridge || 32 || No || 203 || Forget || Set when a bridge has been broken || N/A ||
|-
| Pikmin Seeds || 33 || No || 204 || Keep || Set when leaving a seed in the ground || N/A ||
|-
| Pikmin Seed Growth || 35 || No || 205 || Keep || Set when the onion shoots a seed? || N/A ||
|-
| Pikmin Onions || 36 || No || 207 || Keep || Set when yellows are unlocked || N/A ||
|-
| Meet Yellow Pikmin || 37 || No || 206 || Forget || Set upon plucking the first Yellow || Unset when a yellow picks up a Bomb Rock ||
|-
| Blue Pikmin in water || 38 || No || 208 || Forget || Set when a blue Pikmin touches water || Unset upon starting a file || The last unused and untranslated log. Probably unused since you literally find blues in the water.
|-
| Pikmin on Fire || 39 || No || 209 || Forget (GameCube) <br> Reset (Wii/Switch) || Set when a Pikmin catches on fire || N/A ||
|-
| Smoky Progg || 40 || No || 400 || Reset || Set upon Progg shaking off Pikmin || N/A ||
|-
| Bulborbs || 41 || No || 401 || Reset || Set upon killing a Bulborb (or dwarf?) || N/A ||
|-
| Puffstool || 42 || No || 402 || Reset || Set when Puffmin attack Olimar || N/A ||
|-
| Flint Beetle || 43 || No || 403 || Reset || Set when hitting the Flint Beetle || N/A ||
|-
| Honeywisp || 44 || No || 404 || Reset || Set when hitting a Honeywisp || N/A ||
|-
| Candypop Bud || 45 || No || 405 || Reset || Set when using a Candypop Bud || Unset when a Candypop Bud dies ||
|-
| Beady Long Legs || 46 || No || 406 || Reset || Set when Beady drops || Unset when Beady dies ||
|-
| Cannon Beetle || 47 || No || 407 || Reset || Set when Cannon Beetle shoot || Unset when Cannon Beetle dies ||
|-
| Snagret || 48 || No || 408 || Reset || Set when a Snagret attacks || Unset when a Snagret dies ||
|-
| Emperor || 49 || No || 409 || Reset || Set when Emperor does... anything really || Unset when Emperor dies || Seriously, the flag is enabled in like 20 different places.
|-
| Goolix || 50 || No || 410 || Reset || Set when something touches Goolix || Unset when Goolix dies ||
|-
| Mamuta || 51 || No || 411 || Reset || Set when Mamuta sees Olimar || N/A ||
|-
| Sheargrub || 52 || No || 412 || Reset || Set when a sheargrub attacks || N/A ||
|-
| Fiery Blowhog || 53 || No || 413 || Reset || Set when a Fiery Blowhog attacks || N/A ||
|-
| Pearly Clam-clamp || 54 || No || 414 || Reset || Set when a Clam dies || N/A ||
|-
| Breadbug || 55 || No || 415 || Reset || Set when a Breadbug dies || N/A ||
|-
| Puffy Blowhog || 56 || No || 416 || Reset || Set when a Puffy Blowhog Attacks || Unset when a Puffy Blowhog dies || Strange that this one would missable, unless Puffy Blowhog was once a boss of some sort :thinking:
|-
| Wollywog || 57 || No || 417 || Reset || Set when a Wollywog dies || N/A ||
|-
| Nothing Log 1 || 58 || Yes || 600 || Keep || Set on starting file || N/A || From here on are the default logs you get if nothing was done that day.
|-
| Nothing Log 2 || 59 || Yes || 601 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 3 || 60 || Yes || 602 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 4 || 61 || Yes || 603 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 5 || 62 || Yes || 604 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 6 || 63 || Yes || 605 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 7 || 64 || Yes || 606 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 8 || 65 || Yes || 607 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 9 || 66 || Yes || 608 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 10 || 67 || Yes || 609 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 11 || 68 || Yes || 610 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 12 || 69 || Yes || 611 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 13 || 70 || Yes || 612 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 14 || 71 || Yes || 613 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 15 || 72 || Yes || 614 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 16 || 73 || Yes || 615 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 17 || 74 || Yes || 616 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 18 || 75 || Yes || 617 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 19 || 76 || Yes || 618 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 20 || 77 || Yes || 619 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 21 || 78 || Yes || 620 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 23 || 79 || Yes || 621 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 24 || 80 || Yes || 622 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 25 || 81 || Yes || 623 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 26 || 82 || Yes || 624 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 27 || 83 || Yes || 625 || Keep || Set on starting file || N/A ||
|-
| Nothing Log 28 || 84 || Yes || 626 || Keep || Set on starting file || N/A || "I am so very tired." You can't see this because of days like 1, 10, and 29 that have unavoidable logs. It was probably meant for day 30.
|}

[[Category:Pikmin]]
[[Category:Constants]]

Pikmin 2 instructions

2026-01-03T06:05:39Z

Iwillremembermypasswordthistime: update tool versions

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|Elaborate.}}

It's recommended you refer to the file lists and other pages on the main page while editing.

==Tools and files==

Here are some prominent files that come up when modding.
.DOL: Segmented executable binary format 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. Usually named wScene in Pikmin 2.
.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.
.BCK: Keyframed animation data.

Here are some prominent tools:

[https://github.com/SuperHackio/WiiExplorer/releases/tag/V2.0.0.0 WiiExplorer]- Used for extracting and converting RARC archives. Can also compress archives to 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://github.com/XAYRGA/JAIMaker/releases/download/1.7.5/JAIMaker.1.7.5.-.Ominous.Variable.Resistor.zip JAIMaker] - Used for creating custom sequenced music as BMS files. Also supports creating interactive overworld music. Cave music requires additional hex editing.
[https://github.com/XAYRGA/jatast/releases/download/1.1/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/snailspeed3/RiiStudio/releases/download/Alpha-5.11.5/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/2.0.0 GameCube File Tools] - Used for modification of many GameCube/early Wii era formats, notably BTI files.
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.

A page listing the game's internal filesystem is [https://pikmintkb.com/wiki/Pikmin_2_directory_tree here], useful for keeping track of where editable files are.

==Cave editing==

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

See [https://pikmintkb.com/wiki/Cave_generation_parameters this page] for cave generation specifics.

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

You can edit overworld generation with the Gen & Route Editor

Instructions on how to use the program are in its reademe as well as the page on this website.
See [https://pikmintkb.com/wiki/Pikmin_2_area_generator_file this page] for overworld generation specifics.

To change what sounds are made when a leader walks on ground, or to change where Pikmin seeds can sprout, use obj2grid to convert the grid.bin/mapcode.bin files (located in texts.szs for a given area or cave unit model) to obj, then import this obj into blender. Make a material on the mesh you want to edit, and name it according to this scheme:

0xXY

First Digit (Physical characteristics):

Pikmin seeds can root:
0 - full friction (friction is slipperyness)
1 - some friction
2 - no friction

Pikmin seeds die:
4 - full friction
5 - some friction
6 - no friction

Second Digit (Sound index):

0 - grass
1 - soil
2 - sand
3 - wood
4 - water
5- stone
6 - iron
7 - snow
8 - water (has water particle effects when used with 1 as the first digit)
9 - paper

export the model back to obj, use obj2grid to convert the obj to grid.bin/mapcode.bin, and import back into the game.

==Model replacement==
see this guide for now
https://pikmintkb.com/wiki/Custom_models

==Adding more treasures==

create a new szs in \user\Abe\Pellet\<region> with your bmd, as well as the carry.bck animation. make sure that the bmd and szs are named the same thing (ex. ahiru.bmd, ahiru.szs).
then go to otakara_config.txt in pelletlist_(language).szs and add a new entry for your custom treasure, and edit anything you need to. make sure the names refer to the correct things. At the top of the file, increment the number at the top (normally 188). then, open otakara_texts.szs and create a new folder with the same name as your szs containing an animmgr.txt and a collinfo.txt (you can copy these from another treasure).
This is all you need to do to get the treasure working in game, however the piklopedia requires a bit more work.
go to \user\Matoba\resulttex\us\arc.szs and again create a folder with the name of your custom treasure. this is where you will but an icon for your treasure.
the icon should be a 32 x 32 bti image named texture.bti.
finally, go to \message\mesRes_<language>.szs and extract pikmin2.bmg using the bmg tool in ⁠pikmin-tools. there, you will add an entry for your treasure's in game name (this does not have to be the same name as the one in the filesystem) and also a piklopedia entry for your treasure. You should be all set at that point.

==Menu and HUD editing ==

BLO files, which house most of the screen resources, can be edited with pyblo2-gui. Often, positions of a UI element may be controlled by a BCK element, which can be edited in the animation part of the program.
BRK and BTK animations may also be involved,which can be edited with bark_conv and btk-conv respectively. BPK files can be edited with j3d-animation-editor.

==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. Review [https://docs.google.com/document/d/1UNhdBL3tYAn9sHO8gdOVJIpaHVo9_bbCLz7OazkEgZA/edit this document] to see what instruments you can use for your song depending on what bms you're replacing (if you're not editing wScenes with the Sound Modding Toolkit, that is)

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, wScene editing + creation, 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]]

RARC file

2025-12-26T17:56:17Z

Iwillremembermypasswordthistime: wiiexplorer got the update

The RARC file format is an archive format commonly found in first party Nintendo GameCube games. Many files are stored in these archive files in a similar way to ZIP and 7Z files.

In Pikmin 2's file structure, ARC files are nowhere near as common as the SZS file, which is a version of the format that's compressed via Yaz0 compression.

Extracting and repacking these archives is done by using WiiExplorer. WiiExplorer also allows compressing archives with Yaz0 compression. When Yaz0 compressing archives, you must enable the setting to pad them to 32 bytes.

= Format Specifications =
Below you'll find helpful tables on how the file is structured
== Header ==
Each RARC starts with a ''header''
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || String || "RARC" in ASCII
|-
| 0x04 || UInt32 || Size of the entire file
|-
| 0x08 || UInt32 || Data Header Offset (Always 0x20)
|-
| 0x0C || UInt32 || Offset to the File Data section minus 0x20
|-
| 0x10 || UInt32 || Length of the File Data section
|-
| 0x14 || UInt32 || Size of all the MRAM Files in the File Data section
|-
| 0x18 || UInt32 || Size of all the ARAM Files in the File Data section
|-
| 0x1C || UInt32 || Size of all the DVD Files in the File Data section
|-
|}
== Data Header ==
This section has information on the entire archive
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt32 || The number of Directory Nodes
|-
| 0x04 || UInt32 || Offset to the Directory Nodes section minus 0x20 (always 0x20)
|-
| 0x08 || UInt32 || The number of File Nodes
|-
| 0x0C || UInt32 || Offset to the File Nodes section minus 0x20
|-
| 0x10 || UInt32 || Size of the String Table
|-
| 0x14 || UInt32 || String Table offset minus 0x20
|-
| 0x18 || UInt16 || The next available File Index
|-
| 0x1A || bool || Keeps the File ID's Synced (Always 0x01, or TRUE in SMG)
|-
| 0x1B || UInt8[5] || Padding, All 0x00's
|-
|}
== Directory Node section ==
This section is a list of information for each folder (or, subdirectory) in the archive.<br/>
Each list entry looks like this:
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || String || The first 4 characters in the Directory's name in all caps.<br/>Example: "RootFolder" = "ROOT", and "Tmp" = "TMP " (Names less than 4 characters are padded to 4 characters with spaces)
|-
| 0x04 || UInt32 || Offset to the Directory's name in the String Table
|-
| 0x08 || UInt16 || Hash of the Directory's name
|-
| 0x0A || UInt16 || The number of File Nodes in this directory
|-
| 0x0C || UInt32 || Offset to the first File Node in the File Nodes section
|-
|}
== File Node section ==
This section is a list of information for each file in the archive. It also contains entries for directories so we can know which directory belongs where.<br/>
Each list entry looks like this:
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Node Index (0xFFFF if this entry represents a subdirectory)
|-
| 0x02 || UInt16 || Hash of the Node's name
|-
| 0x04 || UInt8 Bitfield || Defines certain Node Attributes. See the Node Attributes table below.
|-
| 0x05 || UInt8[1] || Padding. 0x00
|-
| 0x06 || UInt16 || Offset to the Node's name in the String Table
|-
| 0x08 || UInt32 || If this node represents a file: Offset to the File's Data in the File Data section.<br/>If this node represents a directory: Directory Node section index to use
|-
| 0x0C || UInt32 || If this node represents a file: Size of the File's Data.<br/>If this node represents a directory: The size of the Directory Node (always 0x10)
|-
|}
=== Node Attributes ===
{| class="wikitable"
! Mask !! Name !! Description
|-
| 0x01 || FILE || This node is a File
|-
| 0x02 || DIRECTORY || This node is a Directory
|-
| 0x04 || COMPRESSED || This node's file is compressed
|-
| 0x10 || PRELOAD_TO_MRAM || Set the file to be loaded into Main RAM
|-
| 0x20 || PRELOAD_TO_ARAM || Set the file to be loaded into Auxiliary RAM (GameCube only)
|-
| 0x40 || LOAD_FROM_DVD || Set the file to be loaded right off the DVD when needed
|-
| 0x80 || YAZ0_COMPRESSED || This node's file is specifically YAZ0 compressed. Enable the COMPRESSED flag as well when using this
|-
|}

Among the File Nodes are nodes for a ".." and "." directory. The "." entry points to the current directory, and the ".." directory points to the parent directory (or 0xFFFFFFFF if the current directory is the topmost directory).

== String Table ==
This section is composed of NULL-terminated ASCII strings. The above information references these strings.

== File Data section ==
This section is a chunk of all the data that files in the archive contain. Files are sorted in a specific order, and are padded to the nearest 32 byte boundary.<br/>The sorting order is MRAM Files then ARAM Files then DVD Files.

Pikmin 2 troubleshooting

2025-12-19T02:36:27Z

Iwillremembermypasswordthistime: another common pratfall

Solutions to common problems that can occur while editing ''Pikmin 2'''s files.

Note: Get the automatic crash debugger screen code listed below before continuing, as that crash screen can provide valuable info on what caused a crash.

<code>
Automatically Show Exception Handler (GameCube USA)
0442219c 60000000

Automatically Show Exception Handler (GameCube PAL)
04422440 60000000

Automatically Show Exception Handler (GameCube JPN)
04423ca0 60000000

Automatically Show Exception Handler (Wii USA)
044a803c 60000000

Automatically Show Exception Handler (GameCube USA Demo 1)
04422218 60000000
</code>

== Custom models ==
===My custom model has random stretchy bits ===
:Check your weight painting on the model, partial weights should not be used.

== Overworlds and Caves ==
=== The changes I made to the overworld aren't applying ===
:You need to create a new save, most things are only loaded on first entry

=== Adding more sublevels to a vanilla cave crashes ===
:Make sure the number of entries in the BgmList (located in <code>user/Totaka</code>) for the cave matches the number of sublevels that are in the cave.

=== The game crashes when I edit the Valley of Repose ===
:A tutorial cutscene is hardcoded to look for a paper bag with a weight of 20. If you edit the weight of the bag or remove it, revert those changes.

=== Loading a cave stays stuck for longer than usual and eventually crashes Dolphin ===
:Open the [[cave definition file]] and go to the sublevel you were trying to load. Make sure that the amount of entries on <code>TekiInfo</code>, <code>ItemInfo</code>, etc. blocks matches the number present at the start of that same block (this number commented with <code>num</code>).

== Other common crashes ==
===The crash screen said "Memory Alloc Error"===
:That means the game is out of memory. Try reducing the size of a model, or the amount of enemies in an overworld, or whatever change you made that caused the error

[[Category:Pikmin 2]]
[[Category:Troubleshooting]]

Cutscene Editing and Creation

2025-10-27T13:16:39Z

Iwillremembermypasswordthistime: flag and particle notes

This page will run through editing and creating your own cutscenes in Pikmin 2. <br>
Cutscenes use the JStudio library, which was used in Wind Waker, Twilight Princess, Pikmin 2, and Skyward Sword.<br>
In Pikmin 2, cutscenes are contained in <code>demo.szs</code> files in <code>user/Mukki/movie</code>.<br>
Inside these szs files are a few assets, most notably the JStudio Binary (STB) file. This file controls initialization of cutscene data, as well as camera instructions.<br>
We can use a program called [https://drive.google.com/file/d/1JNqFF1IuJgdwzNA3XvVUEapyCwc2xfvP STB2JSON] to convert this to a more readable format.<br>

Note when extracting cutscene archives, you must use a program like WiiExplorer that can preserve the file indexes. This is because stb files load assets based in index, not by filename.<br>

<h1>STB Basics</h1>

STB files are separated into different "blocks" that can represent different "objects". The available blocks in the format are:

- JFVB (function value block)<br>
- JCMR (camera)<br>
- JABL (ambient light)<br>
- JACT (actor)<br>
- JSND (sound)<br>
- JLIT (light)<br>
- JCNT (control)<br>
- JMSG (message)<br>
- JFOG (fog)<br>
- JPTC (particle)<br>

Pikmin 2 only uses JFVB, JCMR, JCNT, JACT, JMSG, and JSND (which are the blocks that are going to be covered here), though the other blocks are theoretically supported. (note STB2JSON only supports the blocks vanilla uses) Particles are instead actors with a special identifier (an @ symbol in front of the name of the actor)

An object has both properties and variables, which control various things about that object.

Objects also have different "commands" to affect variables and properties of an object.<br>

The "VAR" command binds a value or function to a variable.<br>

* Its syntax is: <code>"VAR (VarName) (Value/function) (Data)"</code>

*The value/function types are:
** Void, to write a 0 to the variable
** Immediate, to write a direct value to the variable (specified in <code>(Data)</code>)
** Time, to write a direct value, that is multiplied by the number of frames since the last "WAIT" command multiplied by 0.03333333, to the variable (specified in <code>(Data)</code>)
** Index, to attach a JFVB function to the variable (the function index is specified in <code>(Data)</code>).

* A variable can affect more than one value of the bound object, in this case, the <code>(Data)</code> field will have more than 1 value.<br>

The "SET" command directly affects the properties of the bound object.<br>

* How you set a property is dependent on what the property is (hence they don't have a specific way of being set, unlike variables.) <br>

The "WAIT" command halts the execution of the object for a certain amount of frames.<br>
* After the delay of a "WAIT" command has passed, ALL value/functions will be unbound from the variables.

The "SYNC" command halts the execution of the object until an event, external to the STB, is fired.<br>

The "OFLG", "XFLG" and "AFLG" commands (respectively) OR/XOR/AND the stb flags with a value.<br>

An object's name is defined by the "Type" field.

The JFVB block is the only one that does not represent objects. Instead, it holds "functions" all that represent data and how it evolves over time. There are two main types of functions used in Pikmin 2: "Constant", which contains a value that never changes, and "Hermite", which contains a value that changes following Hermite interpolation. There is also "List-Parameter", which contains a value that changes based on either spline or linear interpolation.
This is where values such as animation translation data and camera coordinates are stored.

A group of values typically looks like this:
<pre>
{
"Func": "Hermite",
"Range": "0.0 12.966666",
"Data": [
[
"0.0",
"70.229546",
"0.0",
[
"12.966666",
"188.07487",
"0.0",
],
]
},</pre>

The range is typically the start and end frames of the movement, if the value is not a constant value. To convert between the time values in range and frames, divide the frame number by 0.03333333.<br>
in this example, 12.966666 becomes roughly frame 389. To convert frames to time, multiply by 0.03333333.

In the Data field there will be subgroups of values with two floats, the first float being the time and the second being the value of whatever you're putting (camera coordinates, animation translation data, etc). <br>
In a List_Parameter function, there will be another group under "Range", that will detail the type of interpolation used in the function, either "Linerar" or "BSPline".<br>
<pre>
"Range": "0.0 0.666667",
"Interpolation": "BSPLine",
</pre>
In a Hermite function, each subgroup of values instead has three floats. The first one is time, the second is the value of whatever you're putting , and the third is the tangent value for the hermite interpolation. Setting tangent values to 0.0 will result in a smooth ease.

<h2>demos.txt notes</h2>
Before getting into major cutscene editing, there are a few things to note in <code>user/Mukki/movie/demos.txt</code>, the file that controls cutscene configs.<br>

Position flags, skip flags, and draw flags are contained here.<br>

A position flag of 2 will use the origin and camera angle specified in <code>demos.txt</code> (both value are confusingly named origin in the file, but the origin is the one with three floats and the angle is the one with one float)<br>
A position flag of 4 or 8 will use the origin and camera angle specified in the code that plays the specific cutscene. (8 specifically will also try to get the best camera angle for the cutscene when played)<br>
A position flag of 16 will do the same as 4 & 8, in addition to taking into account the sound position of certain objects in the cutscene (specified in code)<br>

Draw flags are the left number on pause/draw/fade.<br>
A draw flag of 1 will make pikmin visible.<br>
A draw flag of 2 will make enemies visible.<br>
A draw flag of 4 will make pellets visible.<br>
A draw flag of 8 will make navis visible.<br>
These flags can be combined; for example, to draw all of them would be 15.<br>

Fade flags are the right number on pause/draw/fade.<br>

A fade flag of 3 will have a smooth fade to black open the cutscene.<br>
A fade flag of 6 will have a sharp cut open the cutscene.<br>

Skip flags are labeled with just "flag"<br>

0=start skips, 1=any button skips, 2=unskippable.<br>

<h1>Camera</h1>

Note when getting camera coordinates, the position coordinates and target coordinates will be relative to the origin of the cutscene's location (wherever it is activated). The origin of a cutscene is specified in <code>user/Mukki/movie/demos.txt</code>, and that value will need to be accounted for when getting coordinate values. <br>

For this example, we will be using a cutscene <code>(x01_gamestart)</code> with an origin of <code>0.0, 0.0, 0.0</code>, and we will use the pikmin 2 gen editor to get coordinates, where values will be relative to <code>0.0, 0.0, 0.0</code> of the map's origin (which will serve as our cutscene origin, as the position flag is set to 2). (You can also use blender to get coordinates, which is especially helpful when using a custom map. This tutorial will use the gen editor, but Blender steps will be detailed later below.)<br>

Let's start making our stb. It's a good idea to start by getting a vanilla stb, and converting it to json, then editing our own values in.<br>
First, we're just doing camera, so delete everything aside from the JFVB and JCMR blocks.

To setup our camera block, input this information:

<pre>"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},</pre>

Setting the Type to "camera" will set the camera.<br>

Camera variables are:<br>

* ProjFovy - the field of view (FOV) of the camera. (float)
* ViewRoll - the rotation of the camera. (float)
* ViewPos - the XYZ position of the camera in the world. (float)
* TargPos - the XYZ position of where the camera is looking in the world. (float)
* Distance - the culling distance of the camera. It is usually set to <code>1.0 12800.0</code> (near distance, far distance) (float)

The indexes here correspond to values in the function value block. For instance, TargPos index 7 will have the Z coordinate of where the camera is looking take the values from the eighth group in the JFVB block.<br>
The index counts from 0.

Let's start setting some values. Our first value (ProjFovy) will be the FOV of our camera. We want to keep it a constant value, so well have our first FVB group look like this:
<pre>
{ (this is the bracket for the start of our JSON)
"JFVB": { (this is the bracket for the start of the JFVB block)
"Values": [ (this is the bracket for the start of all data values in the block)
{
"Func": "Constant",
"Data": "45.0",
},</pre>

Our next group will be rotation values. As before, we want to keep this constant.
<pre>
{
"Func": "Constant",
"Data": "0.0",
},</pre>

Our JSON should now look like this:
<pre>
{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},

}</pre>

Now it's time to get position coordinates from the gen editor. Open up the files for the valley of Repose, as that is the location of where our cutscene is.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage1.png
</gallery>
Place a reference object for the first set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage2.png
</gallery>
Copy the XYZ coordinates of the object into the JSON. They should be in the third (X), fourth (Y), and fifth (Z) set of values as Hermite functions. <br>
The first time value should be 0.0, for the start of the cutscene. Make sure the range is from frames 0 to 565 (converted to time).
<pre>
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
]
},</pre>

Place a reference object for the second set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage3.png
</gallery>
Copy the XYZ coordinates of the second object into the JSON as the second set in the value groups.
The time value should be 18.83333145 (frame 565), for the end of the cutscene.
<pre>{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},</pre>
Now for the target coordinates. It helps to move your position in the gen editor to one of your position reference objects, to get a betteer view of where you want your camera to look.<br>
Place a reference object for your target coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage4.png
</gallery>
We'll use a Constant function for the target, since we currently do not want where the camera is looking to change.
Copy the XYZ coordinates of the object into the JSON. They should be in the sixth (X), seventh (Y), and eighth (Z) set of values.<br>

<pre>{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
](this is the bracket for the end of all data values in the block)
},(this is the bracket for the end of the JFVB block)</pre>

This is what your JSON should look like now:

<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
}</pre>

Now you can save your JSON, use STB2JSON to convert it to STB, then repack the cutscene archive.
If everything was done correctly, it should look like this ingame:
<gallery mode="packed-hover" widths=400px heights=400px>
File:cutscene1.gif
</gallery>
If using Blender for coordinates, assuming your map is centered correctly, you can use the coordinates of Blender's camera for the cutscene coordinates.<br>
To convert between Blender coords and game coords, the X value remains the same, the Z coordinate in blender will be the Y coordinate in game, and the Y coordinate in blender should be multiplied by -1.<br>
Location XYZ will be ViewPos, and Rotation XYZ will be TargPos.<br>
<h1>Actors (and particles)</h1>

Actors are the most complicated part of cutscenes, so we'll need to break a few things down. <br>

There are four main types of actors:

Game Actors, which are certain creatures in the game world (like navis and onions). These are denoted with a <code>*</code> symbol in front of the actor's name. <br>
Special Actors, which are actors that can activate certain special functions in game. These are denoted with a <code>+</code> symbol in front of the actor's name. <br>
Particle Actors, which are particles. These are denoted with a <code>@</code> symbol in front of the actor's name. <br>
Actors, which are regular models placed in a cutscene. These are denoted with a <code>p</code> symbol in front of the actor's name, though this doesn't seem to be required. <br>

Sound effects are not part of the JACT block, but behave similarly to actors. These are denoted with a <code>#</code> symbol in front of the actor's name.

<h3>Game Actors</h3>

For Game Actors, each one has an identifier:

* <code>"theOrima"</code> is Olimar.
* <code>"theLouie"</code> is Louie/President.
* <code>"orimaAlive_1"</code> is the first alive leader.
* <code>"orimaAlive_2"</code> is the second alive leader.
* <code>"orimaDead_1"</code> is the first dead leader.
* <code>"orimaDead_2"</code> is the second dead leader.
* <code>"onyon_R"</code> is the Red Onion.
* <code>"onyon_Y"</code> is the Yellow Onion.
* <code>"onyon_B"</code> is the Blue Onion.
* <code>"ufo"</code> is the Hocotate Ship.
* <code>"pod"</code> is the Research Pod.
* <code>"pikmin"</code> is the target of the cutscene, if that target is a Pikmin.
* <code>"orima"</code> or "player" is the current active player.
* <code>"target</code>" is the target of the cutscene.

Game Actor variables are:

* Translation - the XYZ actor position offset from the movie position. (float)
* Rotation - the XYZ rotation of the actor relative to the actor's default orientation. Only the Y value seems to be used (float)

Game Actor properties are:

* AnimData
* Anim
* MovieTranslation

AnimData sets the index of the BCK data in the cutscene archive that will be applied to the creature it's set to affect. (int)
Anim sets which animation will be used. Setting Anim to "BCK" will use the BCK, while setting it to "None" will use the creature's base animation archive. (string)

Here's an example from the unused red onion boot cutscene <code>(g02_boot_onyonR)</code>:
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"SET MovieTranslation None",
"SET Anim None",
"SET AnimData 4",

</pre>

Here, Anim is set to None, so the animation will instead come from the onion's animations, and AnimData being set to 4 (counting from 0) will have the onion perform the fifth animation in the onion's <code>animmgr.txt</code>, which is <code>bootup.bck</code>.<br>

MovieTranslation defines how translation will be applied to the actor (string):

* "None" wont do anything,
* "Direct" will directly copy the translation to the actor position,
* "MinY" will directly copy the X and Z translations to the actor position, but set the Y position to the map's minimum Y,
* "FaceDir" will directly copy the translation to the actor position and copy the Y value of the Rotation variable to the direction the actor is facing,
* "MoviePos" will copy the movie position to the actor position.

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*theLouie",
"Commands": [
"VAR Translation Index 16 17 18",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 3",
"WAIT 70",
"VAR Translation Index 19 20 21",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 4",
"WAIT 350",
]
},</pre>
Here, our actor is <code>*theLouie</code> (Louie), the first set of translation (in this case, movement of Louie's model) coordinates come from the value groups at indexes 16, 17, 18 (counting from 0) in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fourth (0, 1, 2, 3) file in the archive as the animation.
<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage1.png
</gallery>
After waiting 70 frames (and after the textbox is cleared) the second set of translation coordinates come from the value groups at indexes 19, 20, 21 in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fifth (0, 1, 2, 3, 4) file in the archive as the animation.<br>

Translation coordinates can be obtained the same way as obtaining camera position coordinates. <br>

Onions (including the ship and pod), navis, underground cave holes, and geysers also have their own special properties that can be set. When these properties are set, special functions specific to that creature that can be executed. <br>

(note: the format for these identifiers is hex value/JSON name)<br>

Onions<br>

* 0x64/CreateHead1 - create sprout
* 0x65/Spot - starts onion/ship/pod spot effect
* 0x66/SpotState - stops onion/ship/pod spot effect
* 0x67/StartPropera - start ship propeller animation
* 0x68/StopPropera - stop ship propeller animation
* 0x69/CreateHead2 - create sprout

Navi <br>

* 0x64/EnterPikis - make Pikmin go into the onion/ship
* 0x66/HoleInPikis - make Pikmin go into a cave hole
* 0x67/FountainPikis - make Pikmin jump onto a geyser
* 0x68/DelShadow - hide leader shadow
* 0x69/DelParticles - hide leader particles
* 0x6a/AddParticles - show leader particles
* 0x6b/AddShadow - show leader shadow

Hole<br>

* 0x64 - make hole appear

Geyser

* 0x64 - make geyser appear

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"WAIT 105",
"SET CreateHead2",
"WAIT 315",
]
},</pre>

<h3>Particle Actors</h3>

Particle Actors are particles, getting their data from the <code>efx.jpc</code> included in the cutscene archive.

Particle actors have two properties:

* Parc - the particle ID (Short) and the particle list index (Byte) in the JPC.
* Targ - the object on which the particle will appear. If a second string is specified, the particle will appear on the object's model joint specified by the second string

Example:

<pre>"JACT": {
"Type": "@boot_gr_b",
"Commands": [
"SET Parc 5 5",
"SET Targ *onyon_R",
"WAIT 390",
]
},
"JACT": {
"Type": "@boot_gr_o",
"Commands": [
"SET Parc 6 5",
"SET Targ *onyon_R body_1",
"WAIT 390",
]
},</pre>

Particles have three variables:<br>

* Translation - XYZ position offset from the position of the object it is attached to, or the cutscene position if not attached to an object.(float)
* Rotation - XYZ rotation relative to the particle's default orientation(float)
* Scaling - XYZ size relative to the particle's default size(float)

If "ground" is the second string, the particle will uses the object position and ignore the object matrix.
To kill a particle, set the Targ property again with the first string being "*kill".<br>

<h3>Special Actors</h3>

Special Actors are actors whose can affect parts of the game. When a specific property of the special actor is set, the game will execute special functions depending on the property. They are usually context sensitive.<br>

The properties are:<br>

* 0x00/LeaveCave - abandon treasures and pikmin when giving up
* 0x01/DayEnd - create day end enemies, spawn left behind Pikmin
* 0x02/FallPikiSound - start falling Pikmin sound effects in cave entry
* 0x03/ForceEnterPiki - force Pikmin into the Onion on day 1
* 0x65/StartDemoCamera - start "demo" camera type (using the regular game camera instead of the cutscene camera)
* 0x66/EndDemoCamera - go back to normal player camera
* 0xC9/OpenKentei - open treasure collection UI (res_kantei)
* 0xCB/OpenKentei - open special item collection UI (res_special_item)
* 0x12D/FadeOut - fade the screen
* 0x12E/FadeIn - unfade the screen

Example:
<pre>"JACT": {
"Type": "+MovieCommand",
"Commands": [
"SET FallPikiSound",
"WAIT 219",
]
},</pre>

<h3>Actors</h3>

Actors are regular models that can appear in a cutscene.

Actor properties are:

* BCKIdx - sets the index of the BCK data in the cutscene archive that will be applied to the actor it's set to affect. (int)
* BMDIdx - sets the index of the BMD model the actor will use. (int)

Actor variables are

* Translation - the XYZ actor position offset from the movie position. (float)
* Scaling - the XYZ actor size relative to its default model size. (float)
* Rotation - the XYZ actor rotation relative to its default orientation. (float)<br>

Now that we've absorbed all that, let's add some actors to our cutscene.<br>

We're going to add Olimar, and have him play the down animation from <code>s03_orimadown</code>. We'll keep him stationary.

<pre>"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},</pre>

Note: because we don't have any translation going on here, olimar will be spawned where he would be spawned in regular gameplay.

<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage2.png
</gallery>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Actortutorialimage3.png
</gallery>

<h1>Sounds and messages</h1>

Message blocks are usually paired with a control block, presumably to halt things until the text box is done.<br>

<pre>"JMSG": {
"Type": "メッセージ",
"Commands": [
"WAIT 88",
"SET Code 894 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "コントロール",
"Commands": [
"WAIT 89",
"SYNC 1",
"WAIT 1",
]
},</pre>
The Type for messages is always "メッセージ" ("message"), and the Type for control is always "コントロール" ("control"). If there is more than one message/control in a cutscene, a number will follow the text (e.g. "メッセージ２" for the second message). Note that these aren't required, and currently, replacing the japanese text with english is needed for the rebuilding to not make a malformed STB.
Note the Code being set for the message block. The first three digits (short) are the message index (in decimal) in the [[BMG_file|BMG]]. The last digit (short) is the sub index of the message.

Sounds have two major components: Music, which is handled outside the STB, and sound effects, which for the most part are handled inside the STB.<br>

It's still worth mentioning some things about music:<br>

Which AST that is associated with which cutscene is controlled by <code>PSM::Demo::initiate</code> (in utilityU/PSMainSide_Demo.cpp) in the game's code. The function checks for a cutscene's name, then associates a stream file ID with it.

In vanilla, two cutscenes (<code>x20_blackman</code> and <code>x03_find_red_onyon</code>) are coded not to start with music initially. For the latter cutscene, audio is coded to start after the first text box has been closed.

Now about the other part of cutscene audio: Sound effects.<br>
This is what a typical sound block looks like:
<pre>"JSND": {
"Type": "#orimaAlive_2_1",
"Commands": [
"WAIT 335",
"SET Parent *orimaAlive_2",
"SET ParentNode happajnt3",
"SET ParentEnable True",
"SET Located True",
"SET ID 2161",
"SET BeginFadeIn 0.0",
"WAIT 12",
]
},</pre>

As stated earlier, a <code>#</code> in front of the name of the actor denotes a sound. <br>

Sound's properties are:

* Parent - binds the sound to an actor (in this case, the second alive player, or Louie) (string)
* ParentNode - further binds the sound to a specific joint on the model of the actor (string)
* ParentEnable - sets this binding to true. (boolean)
* Located - tells the sound to follow a position, whether from an attached creature or a direct position variable. (boolean)
* ID - the sound effect ID, in decimal. See [https://pikmintkb.com/wiki/Se.bms this page] for IDs. (int)
* Begin - starts the sound.
* BeginFadeIn - tells the sound to fade in when started, with the time it takes to fade in determined by the float after it.
* End - stops the sound.
* EndFadeOut - tells the sound to fade out when started, with the time it takes to fade out determined by the float after it.

Sound's variables are:

* Volume (float)
* Pan (float)
* Pitch (float)
* TempoProportion (float) - speed
* Fxmix (float) - reverb/echo
* Position (float) - XYZ sound position offset from the movie position

Let's add a sound effect and a text box to our cutscene.<br>

Text box first, we'll use message index 915 (in the BMG, this will show as hex, so it's actually 0x393) and have it appear at the end of the cutscene.

<pre>"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},</pre>

Due to a seemingly hardware dependent bug, the stb created by STB2JSON may have the "control block" represented as <code>0xEFBFBDEFBFBDEFBFBDEFBFBD</code> instead of <code>0xFFFFFFFF</code>, which is the correct one. If this happens, open your stb in a hex editor and change the offending bytes, making sure to delete the extra bytes.
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage1.png
</gallery>
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage2.png
</gallery>
Now let's test in game. <br>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Messagetutorialimage3.png
</gallery>

Finally, let's add a sound. Let's play <code>PSSE_SY_WMAP_MONEY_UP</code> (one of the ka-ching sounds)
We're not going to tie it to any actor, just have it play on its own.

<pre>"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},</pre>

Our whole JSON should now look like this:
<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},
"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},
"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},
}
</pre>
Convert your JSON to STB, remember to fix the control block if needed, repack your archive with WiiExplorer (make sure the file IDs are correct!), and play the cutscene in game.<br>

Congratulations, you have now made a full cutscene! Feel free to experiment with editing vanilla cutscenes, or making more of your own.

Cutscene Editing and Creation

2025-10-23T20:27:28Z

Iwillremembermypasswordthistime: so nintendo can't spell apparently

This page will run through editing and creating your own cutscenes in Pikmin 2. <br>
Cutscenes use the JStudio library, which was used in Wind Waker, Twilight Princess, Pikmin 2, and Skyward Sword.<br>
In Pikmin 2, cutscenes are contained in <code>demo.szs</code> files in <code>user/Mukki/movie</code>.<br>
Inside these szs files are a few assets, most notably the JStudio Binary (STB) file. This file controls initialization of cutscene data, as well as camera instructions.<br>
We can use a program called [https://drive.google.com/file/d/1JNqFF1IuJgdwzNA3XvVUEapyCwc2xfvP STB2JSON] to convert this to a more readable format.<br>

Note when extracting cutscene archives, you must use a program like WiiExplorer that can preserve the file indexes. This is because stb files load assets based in index, not by filename.<br>

<h1>STB Basics</h1>

STB files are separated into different "blocks" that can represent different "objects". The available blocks in the format are:

- JFVB (function value block)<br>
- JCMR (camera)<br>
- JABL (ambient light)<br>
- JACT (actor)<br>
- JSND (sound)<br>
- JLIT (light)<br>
- JCNT (control)<br>
- JMSG (message)<br>
- JFOG (fog)<br>
- JPTC (particle)<br>

Pikmin 2 only uses JFVB, JCMR, JCNT, JACT, JMSG, and JSND (which are the blocks that are going to be covered here), though the other blocks are theoretically supported. (note STB2JSON only supports the blocks vanilla uses) Particles are instead actors with a special identifier (an @ symbol in front of the name of the actor)

An object has both properties and variables, which control various things about that object.

Objects also have different "commands" to affect variables and properties of an object.<br>

The "VAR" command binds a value or function to a variable.<br>

* Its syntax is: <code>"VAR (VarName) (Value/function) (Data)"</code>

*The value/function types are:
** Void, to write a 0 to the variable
** Immediate, to write a direct value to the variable (specified in <code>(Data)</code>)
** Time, to write a direct value, that is multiplied by the number of frames since the last "WAIT" command multiplied by 0.03333333, to the variable (specified in <code>(Data)</code>)
** Index, to attach a JFVB function to the variable (the function index is specified in <code>(Data)</code>).

* A variable can affect more than one value of the bound object, in this case, the <code>(Data)</code> field will have more than 1 value.<br>

The "SET" command directly affects the properties of the bound object.<br>

* How you set a property is dependent on what the property is (hence they don't have a specific way of being set, unlike variables.) <br>

The "WAIT" command halts the execution of the object for a certain amount of frames.<br>
* After the delay of a "WAIT" command has passed, ALL value/functions will be unbound from the variables.

The "SYNC" command halts the execution of the object until an event, external to the STB, is fired.<br>

The "OFLG", "XFLG" and "AFLG" commands (respectively) OR/XOR/AND the stb flags with a value.<br>

An object's name is defined by the "Type" field.

The JFVB block is the only one that does not represent objects. Instead, it holds "functions" all that represent data and how it evolves over time. There are two main types of functions used in Pikmin 2: "Constant", which contains a value that never changes, and "Hermite", which contains a value that changes following Hermite interpolation. There is also "List-Parameter", which contains a value that changes based on either spline or linear interpolation.
This is where values such as animation translation data and camera coordinates are stored.

A group of values typically looks like this:
<pre>
{
"Func": "Hermite",
"Range": "0.0 12.966666",
"Data": [
[
"0.0",
"70.229546",
"0.0",
[
"12.966666",
"188.07487",
"0.0",
],
]
},</pre>

The range is typically the start and end frames of the movement, if the value is not a constant value. To convert between the time values in range and frames, divide the frame number by 0.03333333.<br>
in this example, 12.966666 becomes roughly frame 389. To convert frames to time, multiply by 0.03333333.

In the Data field there will be subgroups of values with two floats, the first float being the time and the second being the value of whatever you're putting (camera coordinates, animation translation data, etc). <br>
In a List_Parameter function, there will be another group under "Range", that will detail the type of interpolation used in the function, either "Linerar" or "BSPline".<br>
<pre>
"Range": "0.0 0.666667",
"Interpolation": "BSPLine",
</pre>
In a Hermite function, each subgroup of values instead has three floats. The first one is time, the second is the value of whatever you're putting , and the third is the tangent value for the hermite interpolation. Setting tangent values to 0.0 will result in a smooth ease.

<h1>Camera</h1>

Note when getting camera coordinates, the position coordinates and target coordinates will be relative to the origin of the cutscene's location (wherever it is activated). The origin of a cutscene is specified in <code>user/Mukki/movie/demos.txt</code>, and that value will need to be accounted for when getting coordinate values. <br>
Position flags are also important to note too.<br>

A position flag of 2 will use the origin and camera angle specified in <code>demos.txt</code> (both value are confusingly named origin in the file, but the origin is the one with three floats and the angle is the one with one float)<br>
A position flag of 4 or 8 will use the origin and camera angle specified in the code that plays the specific cutscene. (8 specifically will also try to get the best camera angle for the cutscene when played)<br>
A position flag of 16 will do the same as 4 & 8, in addition to taking into account the sound position of certain objects in the cutscene (specified in code)<br>

For this example, we will be using a cutscene <code>(x01_gamestart)</code> with an origin of <code>0.0, 0.0, 0.0</code>, and we will use the pikmin 2 gen editor to get coordinates, where values will be relative to <code>0.0, 0.0, 0.0</code> of the map's origin (which will serve as our cutscene origin, as the position flag is set to 2). (You can also use blender to get coordinates, which is especially helpful when using a custom map. This tutorial will use the gen editor, but Blender steps will be detailed later below.)<br>

Let's start making our stb. It's a good idea to start by getting a vanilla stb, and converting it to json, then editing our own values in.<br>
First, we're just doing camera, so delete everything aside from the JFVB and JCMR blocks.

To setup our camera block, input this information:

<pre>"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},</pre>

Setting the Type to "camera" will set the camera.<br>

Camera variables are:<br>

* ProjFovy - the field of view (FOV) of the camera. (float)
* ViewRoll - the rotation of the camera. (float)
* ViewPos - the XYZ position of the camera in the world. (float)
* TargPos - the XYZ position of where the camera is looking in the world. (float)
* Distance - the culling distance of the camera. It is usually set to <code>1.0 12800.0</code> (near distance, far distance) (float)

The indexes here correspond to values in the function value block. For instance, TargPos index 7 will have the Z coordinate of where the camera is looking take the values from the eighth group in the JFVB block.<br>
The index counts from 0.

Let's start setting some values. Our first value (ProjFovy) will be the FOV of our camera. We want to keep it a constant value, so well have our first FVB group look like this:
<pre>
{ (this is the bracket for the start of our JSON)
"JFVB": { (this is the bracket for the start of the JFVB block)
"Values": [ (this is the bracket for the start of all data values in the block)
{
"Func": "Constant",
"Data": "45.0",
},</pre>

Our next group will be rotation values. As before, we want to keep this constant.
<pre>
{
"Func": "Constant",
"Data": "0.0",
},</pre>

Our JSON should now look like this:
<pre>
{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},

}</pre>

Now it's time to get position coordinates from the gen editor. Open up the files for the valley of Repose, as that is the location of where our cutscene is.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage1.png
</gallery>
Place a reference object for the first set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage2.png
</gallery>
Copy the XYZ coordinates of the object into the JSON. They should be in the third (X), fourth (Y), and fifth (Z) set of values as Hermite functions. <br>
The first time value should be 0.0, for the start of the cutscene. Make sure the range is from frames 0 to 565 (converted to time).
<pre>
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
]
},</pre>

Place a reference object for the second set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage3.png
</gallery>
Copy the XYZ coordinates of the second object into the JSON as the second set in the value groups.
The time value should be 18.83333145 (frame 565), for the end of the cutscene.
<pre>{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},</pre>
Now for the target coordinates. It helps to move your position in the gen editor to one of your position reference objects, to get a betteer view of where you want your camera to look.<br>
Place a reference object for your target coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage4.png
</gallery>
We'll use a Constant function for the target, since we currently do not want where the camera is looking to change.
Copy the XYZ coordinates of the object into the JSON. They should be in the sixth (X), seventh (Y), and eighth (Z) set of values.<br>

<pre>{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
](this is the bracket for the end of all data values in the block)
},(this is the bracket for the end of the JFVB block)</pre>

This is what your JSON should look like now:

<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
}</pre>

Now you can save your JSON, use STB2JSON to convert it to STB, then repack the cutscene archive.
If everything was done correctly, it should look like this ingame:
<gallery mode="packed-hover" widths=400px heights=400px>
File:cutscene1.gif
</gallery>
If using Blender for coordinates, assuming your map is centered correctly, you can use the coordinates of Blender's camera for the cutscene coordinates.<br>
To convert between Blender coords and game coords, the X value remains the same, the Z coordinate in blender will be the Y coordinate in game, and the Y coordinate in blender should be multiplied by -1.<br>
Location XYZ will be ViewPos, and Rotation XYZ will be TargPos.<br>
<h1>Actors (and particles)</h1>

Actors are the most complicated part of cutscenes, so we'll need to break a few things down. <br>

There are four main types of actors:

Game Actors, which are certain creatures in the game world (like navis and onions). These are denoted with a <code>*</code> symbol in front of the actor's name. <br>
Special Actors, which are actors that can activate certain special functions in game. These are denoted with a <code>+</code> symbol in front of the actor's name. <br>
Particle Actors, which are particles. These are denoted with a <code>@</code> symbol in front of the actor's name. <br>
Actors, which are regular models placed in a cutscene. These are denoted with a <code>p</code> symbol in front of the actor's name, though this doesn't seem to be required. <br>

Sound effects are not part of the JACT block, but behave similarly to actors. These are denoted with a <code>#</code> symbol in front of the actor's name.

<h3>Game Actors</h3>

For Game Actors, each one has an identifier:

* <code>"theOrima"</code> is Olimar.
* <code>"theLouie"</code> is Louie/President.
* <code>"orimaAlive_1"</code> is the first alive leader.
* <code>"orimaAlive_2"</code> is the second alive leader.
* <code>"orimaDead_1"</code> is the first dead leader.
* <code>"orimaDead_2"</code> is the second dead leader.
* <code>"onyon_R"</code> is the Red Onion.
* <code>"onyon_Y"</code> is the Yellow Onion.
* <code>"onyon_B"</code> is the Blue Onion.
* <code>"ufo"</code> is the Hocotate Ship.
* <code>"pod"</code> is the Research Pod.
* <code>"pikmin"</code> is the target of the cutscene, if that target is a Pikmin.
* <code>"orima"</code> or "player" is the current active player.
* <code>"target</code>" is the target of the cutscene.

Game Actor variables are:

* Translation - the XYZ actor position offset from the movie position. (float)
* Rotation - the XYZ rotation of the actor relative to the actor's default orientation. Only the Y value seems to be used (float)

Game Actor properties are:

* AnimData
* Anim
* MovieTranslation

AnimData sets the index of the BCK data in the cutscene archive that will be applied to the creature it's set to affect. (int)
Anim sets which animation will be used. Setting Anim to "BCK" will use the BCK, while setting it to "None" will use the creature's base animation archive. (string)

Here's an example from the unused red onion boot cutscene <code>(g02_boot_onyonR)</code>:
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"SET MovieTranslation None",
"SET Anim None",
"SET AnimData 4",

</pre>

Here, Anim is set to None, so the animation will instead come from the onion's animations, and AnimData being set to 4 (counting from 0) will have the onion perform the fifth animation in the onion's <code>animmgr.txt</code>, which is <code>bootup.bck</code>.<br>

MovieTranslation defines how translation will be applied to the actor (string):

* "None" wont do anything,
* "Direct" will directly copy the translation to the actor position,
* "MinY" will directly copy the X and Z translations to the actor position, but set the Y position to the map's minimum Y,
* "FaceDir" will directly copy the translation to the actor position and copy the Y value of the Rotation variable to the direction the actor is facing,
* "MoviePos" will copy the movie position to the actor position.

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*theLouie",
"Commands": [
"VAR Translation Index 16 17 18",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 3",
"WAIT 70",
"VAR Translation Index 19 20 21",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 4",
"WAIT 350",
]
},</pre>
Here, our actor is <code>*theLouie</code> (Louie), the first set of translation (in this case, movement of Louie's model) coordinates come from the value groups at indexes 16, 17, 18 (counting from 0) in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fourth (0, 1, 2, 3) file in the archive as the animation.
<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage1.png
</gallery>
After waiting 70 frames (and after the textbox is cleared) the second set of translation coordinates come from the value groups at indexes 19, 20, 21 in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fifth (0, 1, 2, 3, 4) file in the archive as the animation.<br>

Translation coordinates can be obtained the same way as obtaining camera position coordinates. <br>

Onions (including the ship and pod), navis, underground cave holes, and geysers also have their own special properties that can be set. When these properties are set, special functions specific to that creature that can be executed. <br>

(note: the format for these identifiers is hex value/JSON name)<br>

Onions<br>

* 0x64/CreateHead1 - create sprout
* 0x65/Spot - starts onion/ship/pod spot effect
* 0x66/SpotState - stops onion/ship/pod spot effect
* 0x67/StartPropera - start ship propeller animation
* 0x68/StopPropera - stop ship propeller animation
* 0x69/CreateHead2 - create sprout

Navi <br>

* 0x64/EnterPikis - make Pikmin go into the onion/ship
* 0x66/HoleInPikis - make Pikmin go into a cave hole
* 0x67/FountainPikis - make Pikmin jump onto a geyser
* 0x68/DelShadow - hide leader shadow
* 0x69/DelParticles - hide leader particles
* 0x6a/AddParticles - show leader particles
* 0x6b/AddShadow - show leader shadow

Hole<br>

* 0x64 - make hole appear

Geyser

* 0x64 - make geyser appear

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"WAIT 105",
"SET CreateHead2",
"WAIT 315",
]
},</pre>

<h3>Particle Actors</h3>

Particle Actors are particles, getting their data from the <code>efx.jpc</code> included in the cutscene archive.

Particle actors have two properties:

* Parc - the particle ID (Short) and the particle list index (Byte) in the JPC.
* Targ - the object on which the particle will appear. If a second string is specified, the particle will appear on the object's model joint specified by the second string

Example:

<pre>"JACT": {
"Type": "@boot_gr_b",
"Commands": [
"SET Parc 5 5",
"SET Targ *onyon_R",
"WAIT 390",
]
},
"JACT": {
"Type": "@boot_gr_o",
"Commands": [
"SET Parc 6 5",
"SET Targ *onyon_R body_1",
"WAIT 390",
]
},</pre>

Particles have three variables:<br>

* Translation - XYZ position offset from the position of the object it is attached to, or the cutscene position if not attached to an object.(float)
* Rotation - XYZ rotation relative to the particle's default orientation(float)
* Scaling - XYZ size relative to the particle's default size(float)

If "ground" is the second string, the particle will uses the object position and ignore the object matrix.

<h3>Special Actors</h3>

Special Actors are actors whose can affect parts of the game. When a specific property of the special actor is set, the game will execute special functions depending on the property. They are usually context sensitive.<br>

The properties are:<br>

* 0x00/LeaveCave - abandon treasures and pikmin when giving up
* 0x01/DayEnd - create day end enemies, spawn left behind Pikmin
* 0x02/FallPikiSound - start falling Pikmin sound effects in cave entry
* 0x03/ForceEnterPiki - force Pikmin into the Onion on day 1
* 0x65/StartDemoCamera - start "demo" camera type (using the regular game camera instead of the cutscene camera)
* 0x66/EndDemoCamera - go back to normal player camera
* 0xC9/OpenKentei - open treasure collection UI (res_kantei)
* 0xCB/OpenKentei - open special item collection UI (res_special_item)
* 0x12D/FadeOut - fade the screen
* 0x12E/FadeIn - unfade the screen

Example:
<pre>"JACT": {
"Type": "+MovieCommand",
"Commands": [
"SET FallPikiSound",
"WAIT 219",
]
},</pre>

<h3>Actors</h3>

Actors are regular models that can appear in a cutscene.

Actor properties are:

* BCKIdx - sets the index of the BCK data in the cutscene archive that will be applied to the actor it's set to affect. (int)
* BMDIdx - sets the index of the BMD model the actor will use. (int)

Actor variables are

* Translation - the XYZ actor position offset from the movie position. (float)
* Scaling - the XYZ actor size relative to its default model size. (float)
* Rotation - the XYZ actor rotation relative to its default orientation. (float)<br>

Now that we've absorbed all that, let's add some actors to our cutscene.<br>

We're going to add Olimar, and have him play the down animation from <code>s03_orimadown</code>. We'll keep him stationary.

<pre>"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},</pre>

Note: because we don't have any translation going on here, olimar will be spawned where he would be spawned in regular gameplay.

<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage2.png
</gallery>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Actortutorialimage3.png
</gallery>

<h1>Sounds and messages</h1>

Message blocks are usually paired with a control block, presumably to halt things until the text box is done.<br>

<pre>"JMSG": {
"Type": "メッセージ",
"Commands": [
"WAIT 88",
"SET Code 894 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "コントロール",
"Commands": [
"WAIT 89",
"SYNC 1",
"WAIT 1",
]
},</pre>
The Type for messages is always "メッセージ" ("message"), and the Type for control is always "コントロール" ("control"). If there is more than one message/control in a cutscene, a number will follow the text (e.g. "メッセージ２" for the second message). Note that these aren't required, and currently, replacing the japanese text with english is needed for the rebuilding to not make a malformed STB.
Note the Code being set for the message block. The first three digits (short) are the message index (in decimal) in the [[BMG_file|BMG]]. The last digit (short) is the sub index of the message.

Sounds have two major components: Music, which is handled outside the STB, and sound effects, which for the most part are handled inside the STB.<br>

It's still worth mentioning some things about music:<br>

Which AST that is associated with which cutscene is controlled by <code>PSM::Demo::initiate</code> (in utilityU/PSMainSide_Demo.cpp) in the game's code. The function checks for a cutscene's name, then associates a stream file ID with it.

In vanilla, two cutscenes (<code>x20_blackman</code> and <code>x03_find_red_onyon</code>) are coded not to start with music initially. For the latter cutscene, audio is coded to start after the first text box has been closed.

Now about the other part of cutscene audio: Sound effects.<br>
This is what a typical sound block looks like:
<pre>"JSND": {
"Type": "#orimaAlive_2_1",
"Commands": [
"WAIT 335",
"SET Parent *orimaAlive_2",
"SET ParentNode happajnt3",
"SET ParentEnable True",
"SET Located True",
"SET ID 2161",
"SET BeginFadeIn 0.0",
"WAIT 12",
]
},</pre>

As stated earlier, a <code>#</code> in front of the name of the actor denotes a sound. <br>

Sound's properties are:

* Parent - binds the sound to an actor (in this case, the second alive player, or Louie) (string)
* ParentNode - further binds the sound to a specific joint on the model of the actor (string)
* ParentEnable - sets this binding to true. (boolean)
* Located - tells the sound to follow a position, whether from an attached creature or a direct position variable. (boolean)
* ID - the sound effect ID, in decimal. See [https://pikmintkb.com/wiki/Se.bms this page] for IDs. (int)
* Begin - starts the sound.
* BeginFadeIn - tells the sound to fade in when started, with the time it takes to fade in determined by the float after it.
* End - stops the sound.
* EndFadeOut - tells the sound to fade out when started, with the time it takes to fade out determined by the float after it.

Sound's variables are:

* Volume (float)
* Pan (float)
* Pitch (float)
* TempoProportion (float) - speed
* Fxmix (float) - reverb/echo
* Position (float) - XYZ sound position offset from the movie position

Let's add a sound effect and a text box to our cutscene.<br>

Text box first, we'll use message index 915 (in the BMG, this will show as hex, so it's actually 0x393) and have it appear at the end of the cutscene.

<pre>"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},</pre>

Due to a seemingly hardware dependent bug, the stb created by STB2JSON may have the "control block" represented as <code>0xEFBFBDEFBFBDEFBFBDEFBFBD</code> instead of <code>0xFFFFFFFF</code>, which is the correct one. If this happens, open your stb in a hex editor and change the offending bytes, making sure to delete the extra bytes.
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage1.png
</gallery>
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage2.png
</gallery>
Now let's test in game. <br>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Messagetutorialimage3.png
</gallery>

Finally, let's add a sound. Let's play <code>PSSE_SY_WMAP_MONEY_UP</code> (one of the ka-ching sounds)
We're not going to tie it to any actor, just have it play on its own.

<pre>"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},</pre>

Our whole JSON should now look like this:
<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},
"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},
"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},
}
</pre>
Convert your JSON to STB, remember to fix the control block if needed, repack your archive with WiiExplorer (make sure the file IDs are correct!), and play the cutscene in game.<br>

Congratulations, you have now made a full cutscene! Feel free to experiment with editing vanilla cutscenes, or making more of your own.

Cutscene Editing and Creation

2025-10-23T20:22:10Z

Iwillremembermypasswordthistime: adding more info based on twilight princess stb observations

This page will run through editing and creating your own cutscenes in Pikmin 2. <br>
Cutscenes use the JStudio library, which was used in Wind Waker, Twilight Princess, Pikmin 2, and Skyward Sword.<br>
In Pikmin 2, cutscenes are contained in <code>demo.szs</code> files in <code>user/Mukki/movie</code>.<br>
Inside these szs files are a few assets, most notably the JStudio Binary (STB) file. This file controls initialization of cutscene data, as well as camera instructions.<br>
We can use a program called [https://drive.google.com/file/d/1JNqFF1IuJgdwzNA3XvVUEapyCwc2xfvP STB2JSON] to convert this to a more readable format.<br>

Note when extracting cutscene archives, you must use a program like WiiExplorer that can preserve the file indexes. This is because stb files load assets based in index, not by filename.<br>

<h1>STB Basics</h1>

STB files are separated into different "blocks" that can represent different "objects". The available blocks in the format are:

- JFVB (function value block)<br>
- JCMR (camera)<br>
- JABL (ambient light)<br>
- JACT (actor)<br>
- JSND (sound)<br>
- JLIT (light)<br>
- JCNT (control)<br>
- JMSG (message)<br>
- JFOG (fog)<br>
- JPTC (particle)<br>

Pikmin 2 only uses JFVB, JCMR, JCNT, JACT, JMSG, and JSND (which are the blocks that are going to be covered here), though the other blocks are theoretically supported. (note STB2JSON only supports the blocks vanilla uses) Particles are instead actors with a special identifier (an @ symbol in front of the name of the actor)

An object has both properties and variables, which control various things about that object.

Objects also have different "commands" to affect variables and properties of an object.<br>

The "VAR" command binds a value or function to a variable.<br>

* Its syntax is: <code>"VAR (VarName) (Value/function) (Data)"</code>

*The value/function types are:
** Void, to write a 0 to the variable
** Immediate, to write a direct value to the variable (specified in <code>(Data)</code>)
** Time, to write a direct value, that is multiplied by the number of frames since the last "WAIT" command multiplied by 0.03333333, to the variable (specified in <code>(Data)</code>)
** Index, to attach a JFVB function to the variable (the function index is specified in <code>(Data)</code>).

* A variable can affect more than one value of the bound object, in this case, the <code>(Data)</code> field will have more than 1 value.<br>

The "SET" command directly affects the properties of the bound object.<br>

* How you set a property is dependent on what the property is (hence they don't have a specific way of being set, unlike variables.) <br>

The "WAIT" command halts the execution of the object for a certain amount of frames.<br>
* After the delay of a "WAIT" command has passed, ALL value/functions will be unbound from the variables.

The "SYNC" command halts the execution of the object until an event, external to the STB, is fired.<br>

The "OFLG", "XFLG" and "AFLG" commands (respectively) OR/XOR/AND the stb flags with a value.<br>

An object's name is defined by the "Type" field.

The JFVB block is the only one that does not represent objects. Instead, it holds "functions" all that represent data and how it evolves over time. There are two main types of functions used in Pikmin 2: "Constant", which contains a value that never changes, and "Hermite", which contains a value that changes following Hermite interpolation. There is also "List-Parameter", which contains a value that changes based on either spline or linear interpolation.
This is where values such as animation translation data and camera coordinates are stored.

A group of values typically looks like this:
<pre>
{
"Func": "Hermite",
"Range": "0.0 12.966666",
"Data": [
[
"0.0",
"70.229546",
"0.0",
[
"12.966666",
"188.07487",
"0.0",
],
]
},</pre>

The range is typically the start and end frames of the movement, if the value is not a constant value. To convert between the time values in range and frames, divide the frame number by 0.03333333.<br>
in this example, 12.966666 becomes roughly frame 389. To convert frames to time, multiply by 0.03333333.

In the Data field there will be subgroups of values with two floats, the first float being the time and the second being the value of whatever you're putting (camera coordinates, animation translation data, etc). <br>
In a List_Parameter function, there will be another group under "Range", that will detail the type of interpolation used in the function, either "Linear" or "BSPline".<br>
<pre>
"Range": "0.0 0.666667",
"Interpolation": "BSPLine",
</pre>
In a Hermite function, each subgroup of values instead has three floats. The first one is time, the second is the value of whatever you're putting , and the third is the tangent value for the hermite interpolation. Setting tangent values to 0.0 will result in a smooth ease.

<h1>Camera</h1>

Note when getting camera coordinates, the position coordinates and target coordinates will be relative to the origin of the cutscene's location (wherever it is activated). The origin of a cutscene is specified in <code>user/Mukki/movie/demos.txt</code>, and that value will need to be accounted for when getting coordinate values. <br>
Position flags are also important to note too.<br>

A position flag of 2 will use the origin and camera angle specified in <code>demos.txt</code> (both value are confusingly named origin in the file, but the origin is the one with three floats and the angle is the one with one float)<br>
A position flag of 4 or 8 will use the origin and camera angle specified in the code that plays the specific cutscene. (8 specifically will also try to get the best camera angle for the cutscene when played)<br>
A position flag of 16 will do the same as 4 & 8, in addition to taking into account the sound position of certain objects in the cutscene (specified in code)<br>

For this example, we will be using a cutscene <code>(x01_gamestart)</code> with an origin of <code>0.0, 0.0, 0.0</code>, and we will use the pikmin 2 gen editor to get coordinates, where values will be relative to <code>0.0, 0.0, 0.0</code> of the map's origin (which will serve as our cutscene origin, as the position flag is set to 2). (You can also use blender to get coordinates, which is especially helpful when using a custom map. This tutorial will use the gen editor, but Blender steps will be detailed later below.)<br>

Let's start making our stb. It's a good idea to start by getting a vanilla stb, and converting it to json, then editing our own values in.<br>
First, we're just doing camera, so delete everything aside from the JFVB and JCMR blocks.

To setup our camera block, input this information:

<pre>"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},</pre>

Setting the Type to "camera" will set the camera.<br>

Camera variables are:<br>

* ProjFovy - the field of view (FOV) of the camera. (float)
* ViewRoll - the rotation of the camera. (float)
* ViewPos - the XYZ position of the camera in the world. (float)
* TargPos - the XYZ position of where the camera is looking in the world. (float)
* Distance - the culling distance of the camera. It is usually set to <code>1.0 12800.0</code> (near distance, far distance) (float)

The indexes here correspond to values in the function value block. For instance, TargPos index 7 will have the Z coordinate of where the camera is looking take the values from the eighth group in the JFVB block.<br>
The index counts from 0.

Let's start setting some values. Our first value (ProjFovy) will be the FOV of our camera. We want to keep it a constant value, so well have our first FVB group look like this:
<pre>
{ (this is the bracket for the start of our JSON)
"JFVB": { (this is the bracket for the start of the JFVB block)
"Values": [ (this is the bracket for the start of all data values in the block)
{
"Func": "Constant",
"Data": "45.0",
},</pre>

Our next group will be rotation values. As before, we want to keep this constant.
<pre>
{
"Func": "Constant",
"Data": "0.0",
},</pre>

Our JSON should now look like this:
<pre>
{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},

}</pre>

Now it's time to get position coordinates from the gen editor. Open up the files for the valley of Repose, as that is the location of where our cutscene is.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage1.png
</gallery>
Place a reference object for the first set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage2.png
</gallery>
Copy the XYZ coordinates of the object into the JSON. They should be in the third (X), fourth (Y), and fifth (Z) set of values as Hermite functions. <br>
The first time value should be 0.0, for the start of the cutscene. Make sure the range is from frames 0 to 565 (converted to time).
<pre>
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
]
},</pre>

Place a reference object for the second set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage3.png
</gallery>
Copy the XYZ coordinates of the second object into the JSON as the second set in the value groups.
The time value should be 18.83333145 (frame 565), for the end of the cutscene.
<pre>{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},</pre>
Now for the target coordinates. It helps to move your position in the gen editor to one of your position reference objects, to get a betteer view of where you want your camera to look.<br>
Place a reference object for your target coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage4.png
</gallery>
We'll use a Constant function for the target, since we currently do not want where the camera is looking to change.
Copy the XYZ coordinates of the object into the JSON. They should be in the sixth (X), seventh (Y), and eighth (Z) set of values.<br>

<pre>{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
](this is the bracket for the end of all data values in the block)
},(this is the bracket for the end of the JFVB block)</pre>

This is what your JSON should look like now:

<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
}</pre>

Now you can save your JSON, use STB2JSON to convert it to STB, then repack the cutscene archive.
If everything was done correctly, it should look like this ingame:
<gallery mode="packed-hover" widths=400px heights=400px>
File:cutscene1.gif
</gallery>
If using Blender for coordinates, assuming your map is centered correctly, you can use the coordinates of Blender's camera for the cutscene coordinates.<br>
To convert between Blender coords and game coords, the X value remains the same, the Z coordinate in blender will be the Y coordinate in game, and the Y coordinate in blender should be multiplied by -1.<br>
Location XYZ will be ViewPos, and Rotation XYZ will be TargPos.<br>
<h1>Actors (and particles)</h1>

Actors are the most complicated part of cutscenes, so we'll need to break a few things down. <br>

There are four main types of actors:

Game Actors, which are certain creatures in the game world (like navis and onions). These are denoted with a <code>*</code> symbol in front of the actor's name. <br>
Special Actors, which are actors that can activate certain special functions in game. These are denoted with a <code>+</code> symbol in front of the actor's name. <br>
Particle Actors, which are particles. These are denoted with a <code>@</code> symbol in front of the actor's name. <br>
Actors, which are regular models placed in a cutscene. These are denoted with a <code>p</code> symbol in front of the actor's name, though this doesn't seem to be required. <br>

Sound effects are not part of the JACT block, but behave similarly to actors. These are denoted with a <code>#</code> symbol in front of the actor's name.

<h3>Game Actors</h3>

For Game Actors, each one has an identifier:

* <code>"theOrima"</code> is Olimar.
* <code>"theLouie"</code> is Louie/President.
* <code>"orimaAlive_1"</code> is the first alive leader.
* <code>"orimaAlive_2"</code> is the second alive leader.
* <code>"orimaDead_1"</code> is the first dead leader.
* <code>"orimaDead_2"</code> is the second dead leader.
* <code>"onyon_R"</code> is the Red Onion.
* <code>"onyon_Y"</code> is the Yellow Onion.
* <code>"onyon_B"</code> is the Blue Onion.
* <code>"ufo"</code> is the Hocotate Ship.
* <code>"pod"</code> is the Research Pod.
* <code>"pikmin"</code> is the target of the cutscene, if that target is a Pikmin.
* <code>"orima"</code> or "player" is the current active player.
* <code>"target</code>" is the target of the cutscene.

Game Actor variables are:

* Translation - the XYZ actor position offset from the movie position. (float)
* Rotation - the XYZ rotation of the actor relative to the actor's default orientation. Only the Y value seems to be used (float)

Game Actor properties are:

* AnimData
* Anim
* MovieTranslation

AnimData sets the index of the BCK data in the cutscene archive that will be applied to the creature it's set to affect. (int)
Anim sets which animation will be used. Setting Anim to "BCK" will use the BCK, while setting it to "None" will use the creature's base animation archive. (string)

Here's an example from the unused red onion boot cutscene <code>(g02_boot_onyonR)</code>:
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"SET MovieTranslation None",
"SET Anim None",
"SET AnimData 4",

</pre>

Here, Anim is set to None, so the animation will instead come from the onion's animations, and AnimData being set to 4 (counting from 0) will have the onion perform the fifth animation in the onion's <code>animmgr.txt</code>, which is <code>bootup.bck</code>.<br>

MovieTranslation defines how translation will be applied to the actor (string):

* "None" wont do anything,
* "Direct" will directly copy the translation to the actor position,
* "MinY" will directly copy the X and Z translations to the actor position, but set the Y position to the map's minimum Y,
* "FaceDir" will directly copy the translation to the actor position and copy the Y value of the Rotation variable to the direction the actor is facing,
* "MoviePos" will copy the movie position to the actor position.

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*theLouie",
"Commands": [
"VAR Translation Index 16 17 18",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 3",
"WAIT 70",
"VAR Translation Index 19 20 21",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 4",
"WAIT 350",
]
},</pre>
Here, our actor is <code>*theLouie</code> (Louie), the first set of translation (in this case, movement of Louie's model) coordinates come from the value groups at indexes 16, 17, 18 (counting from 0) in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fourth (0, 1, 2, 3) file in the archive as the animation.
<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage1.png
</gallery>
After waiting 70 frames (and after the textbox is cleared) the second set of translation coordinates come from the value groups at indexes 19, 20, 21 in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fifth (0, 1, 2, 3, 4) file in the archive as the animation.<br>

Translation coordinates can be obtained the same way as obtaining camera position coordinates. <br>

Onions (including the ship and pod), navis, underground cave holes, and geysers also have their own special properties that can be set. When these properties are set, special functions specific to that creature that can be executed. <br>

(note: the format for these identifiers is hex value/JSON name)<br>

Onions<br>

* 0x64/CreateHead1 - create sprout
* 0x65/Spot - starts onion/ship/pod spot effect
* 0x66/SpotState - stops onion/ship/pod spot effect
* 0x67/StartPropera - start ship propeller animation
* 0x68/StopPropera - stop ship propeller animation
* 0x69/CreateHead2 - create sprout

Navi <br>

* 0x64/EnterPikis - make Pikmin go into the onion/ship
* 0x66/HoleInPikis - make Pikmin go into a cave hole
* 0x67/FountainPikis - make Pikmin jump onto a geyser
* 0x68/DelShadow - hide leader shadow
* 0x69/DelParticles - hide leader particles
* 0x6a/AddParticles - show leader particles
* 0x6b/AddShadow - show leader shadow

Hole<br>

* 0x64 - make hole appear

Geyser

* 0x64 - make geyser appear

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"WAIT 105",
"SET CreateHead2",
"WAIT 315",
]
},</pre>

<h3>Particle Actors</h3>

Particle Actors are particles, getting their data from the <code>efx.jpc</code> included in the cutscene archive.

Particle actors have two properties:

* Parc - the particle ID (Short) and the particle list index (Byte) in the JPC.
* Targ - the object on which the particle will appear. If a second string is specified, the particle will appear on the object's model joint specified by the second string

Example:

<pre>"JACT": {
"Type": "@boot_gr_b",
"Commands": [
"SET Parc 5 5",
"SET Targ *onyon_R",
"WAIT 390",
]
},
"JACT": {
"Type": "@boot_gr_o",
"Commands": [
"SET Parc 6 5",
"SET Targ *onyon_R body_1",
"WAIT 390",
]
},</pre>

Particles have three variables:<br>

* Translation - XYZ position offset from the position of the object it is attached to, or the cutscene position if not attached to an object.(float)
* Rotation - XYZ rotation relative to the particle's default orientation(float)
* Scaling - XYZ size relative to the particle's default size(float)

If "ground" is the second string, the particle will uses the object position and ignore the object matrix.

<h3>Special Actors</h3>

Special Actors are actors whose can affect parts of the game. When a specific property of the special actor is set, the game will execute special functions depending on the property. They are usually context sensitive.<br>

The properties are:<br>

* 0x00/LeaveCave - abandon treasures and pikmin when giving up
* 0x01/DayEnd - create day end enemies, spawn left behind Pikmin
* 0x02/FallPikiSound - start falling Pikmin sound effects in cave entry
* 0x03/ForceEnterPiki - force Pikmin into the Onion on day 1
* 0x65/StartDemoCamera - start "demo" camera type (using the regular game camera instead of the cutscene camera)
* 0x66/EndDemoCamera - go back to normal player camera
* 0xC9/OpenKentei - open treasure collection UI (res_kantei)
* 0xCB/OpenKentei - open special item collection UI (res_special_item)
* 0x12D/FadeOut - fade the screen
* 0x12E/FadeIn - unfade the screen

Example:
<pre>"JACT": {
"Type": "+MovieCommand",
"Commands": [
"SET FallPikiSound",
"WAIT 219",
]
},</pre>

<h3>Actors</h3>

Actors are regular models that can appear in a cutscene.

Actor properties are:

* BCKIdx - sets the index of the BCK data in the cutscene archive that will be applied to the actor it's set to affect. (int)
* BMDIdx - sets the index of the BMD model the actor will use. (int)

Actor variables are

* Translation - the XYZ actor position offset from the movie position. (float)
* Scaling - the XYZ actor size relative to its default model size. (float)
* Rotation - the XYZ actor rotation relative to its default orientation. (float)<br>

Now that we've absorbed all that, let's add some actors to our cutscene.<br>

We're going to add Olimar, and have him play the down animation from <code>s03_orimadown</code>. We'll keep him stationary.

<pre>"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},</pre>

Note: because we don't have any translation going on here, olimar will be spawned where he would be spawned in regular gameplay.

<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage2.png
</gallery>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Actortutorialimage3.png
</gallery>

<h1>Sounds and messages</h1>

Message blocks are usually paired with a control block, presumably to halt things until the text box is done.<br>

<pre>"JMSG": {
"Type": "メッセージ",
"Commands": [
"WAIT 88",
"SET Code 894 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "コントロール",
"Commands": [
"WAIT 89",
"SYNC 1",
"WAIT 1",
]
},</pre>
The Type for messages is always "メッセージ" ("message"), and the Type for control is always "コントロール" ("control"). If there is more than one message/control in a cutscene, a number will follow the text (e.g. "メッセージ２" for the second message). Note that these aren't required, and currently, replacing the japanese text with english is needed for the rebuilding to not make a malformed STB.
Note the Code being set for the message block. The first three digits (short) are the message index (in decimal) in the [[BMG_file|BMG]]. The last digit (short) is the sub index of the message.

Sounds have two major components: Music, which is handled outside the STB, and sound effects, which for the most part are handled inside the STB.<br>

It's still worth mentioning some things about music:<br>

Which AST that is associated with which cutscene is controlled by <code>PSM::Demo::initiate</code> (in utilityU/PSMainSide_Demo.cpp) in the game's code. The function checks for a cutscene's name, then associates a stream file ID with it.

In vanilla, two cutscenes (<code>x20_blackman</code> and <code>x03_find_red_onyon</code>) are coded not to start with music initially. For the latter cutscene, audio is coded to start after the first text box has been closed.

Now about the other part of cutscene audio: Sound effects.<br>
This is what a typical sound block looks like:
<pre>"JSND": {
"Type": "#orimaAlive_2_1",
"Commands": [
"WAIT 335",
"SET Parent *orimaAlive_2",
"SET ParentNode happajnt3",
"SET ParentEnable True",
"SET Located True",
"SET ID 2161",
"SET BeginFadeIn 0.0",
"WAIT 12",
]
},</pre>

As stated earlier, a <code>#</code> in front of the name of the actor denotes a sound. <br>

Sound's properties are:

* Parent - binds the sound to an actor (in this case, the second alive player, or Louie) (string)
* ParentNode - further binds the sound to a specific joint on the model of the actor (string)
* ParentEnable - sets this binding to true. (boolean)
* Located - tells the sound to follow a position, whether from an attached creature or a direct position variable. (boolean)
* ID - the sound effect ID, in decimal. See [https://pikmintkb.com/wiki/Se.bms this page] for IDs. (int)
* Begin - starts the sound.
* BeginFadeIn - tells the sound to fade in when started, with the time it takes to fade in determined by the float after it.
* End - stops the sound.
* EndFadeOut - tells the sound to fade out when started, with the time it takes to fade out determined by the float after it.

Sound's variables are:

* Volume (float)
* Pan (float)
* Pitch (float)
* TempoProportion (float) - speed
* Fxmix (float) - reverb/echo
* Position (float) - XYZ sound position offset from the movie position

Let's add a sound effect and a text box to our cutscene.<br>

Text box first, we'll use message index 915 (in the BMG, this will show as hex, so it's actually 0x393) and have it appear at the end of the cutscene.

<pre>"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},</pre>

Due to a seemingly hardware dependent bug, the stb created by STB2JSON may have the "control block" represented as <code>0xEFBFBDEFBFBDEFBFBDEFBFBD</code> instead of <code>0xFFFFFFFF</code>, which is the correct one. If this happens, open your stb in a hex editor and change the offending bytes, making sure to delete the extra bytes.
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage1.png
</gallery>
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage2.png
</gallery>
Now let's test in game. <br>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Messagetutorialimage3.png
</gallery>

Finally, let's add a sound. Let's play <code>PSSE_SY_WMAP_MONEY_UP</code> (one of the ka-ching sounds)
We're not going to tie it to any actor, just have it play on its own.

<pre>"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},</pre>

Our whole JSON should now look like this:
<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},
"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},
"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},
}
</pre>
Convert your JSON to STB, remember to fix the control block if needed, repack your archive with WiiExplorer (make sure the file IDs are correct!), and play the cutscene in game.<br>

Congratulations, you have now made a full cutscene! Feel free to experiment with editing vanilla cutscenes, or making more of your own.

Pikmin 2 instructions

2025-10-22T00:49:52Z

Iwillremembermypasswordthistime: update jatast version

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|Elaborate.}}

It's recommended you refer to the file lists and other pages on the main page while editing.

==Tools and files==

Here are some prominent files that come up when modding.
.DOL: Segmented executable binary format 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. Usually named wScene in Pikmin 2.
.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.
.BCK: Keyframed animation data.

Here are some prominent tools:

[https://github.com/SuperHackio/WiiExplorer/releases/download/V1.5.0.5/WiiExplorer.V1.5.0.5.zip WiiExplorer]- Used for extracting and converting RARC archives. Can also compress archives to 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://github.com/XAYRGA/JAIMaker/releases/download/1.7.3/JAIMaker.1.7.3.-.Lightly.Salted.Almond.zip JAIMaker] - Used for creating custom sequenced music as BMS files. Also supports creating interactive overworld music. Cave music requires additional hex editing.
[https://github.com/XAYRGA/jatast/releases/download/1.1/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/2.0.0 GameCube File Tools] - Used for modification of many GameCube/early Wii era formats, notably BTI files.
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.

A page listing the game's internal filesystem is [https://pikmintkb.com/wiki/Pikmin_2_directory_tree here], useful for keeping track of where editable files are.

==Cave editing==

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

See [https://pikmintkb.com/wiki/Cave_generation_parameters this page] for cave generation specifics.

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

You can edit overworld generation with the Gen & Route Editor

Instructions on how to use the program are in its reademe as well as the page on this website.
See [https://pikmintkb.com/wiki/Pikmin_2_area_generator_file this page] for overworld generation specifics.

To change what sounds are made when a leader walks on ground, or to change where Pikmin seeds can sprout, use obj2grid to convert the grid.bin/mapcode.bin files (located in texts.szs for a given area or cave unit model) to obj, then import this obj into blender. Make a material on the mesh you want to edit, and name it according to this scheme:

0xXY

First Digit (Physical characteristics):

Pikmin seeds can root:
0 - full friction (friction is slipperyness)
1 - some friction
2 - no friction

Pikmin seeds die:
4 - full friction
5 - some friction
6 - no friction

Second Digit (Sound index):

0 - grass
1 - soil
2 - sand
3 - wood
4 - water
5- stone
6 - iron
7 - snow
8 - water (has water particle effects when used with 1 as the first digit)
9 - paper

export the model back to obj, use obj2grid to convert the obj to grid.bin/mapcode.bin, and import back into the game.

==Model replacement==
see this guide for now
https://pikmintkb.com/wiki/Custom_models

==Adding more treasures==

create a new szs in \user\Abe\Pellet\<region> with your bmd, as well as the carry.bck animation. make sure that the bmd and szs are named the same thing (ex. ahiru.bmd, ahiru.szs).
then go to otakara_config.txt in pelletlist_(language).szs and add a new entry for your custom treasure, and edit anything you need to. make sure the names refer to the correct things. At the top of the file, increment the number at the top (normally 188). then, open otakara_texts.szs and create a new folder with the same name as your szs containing an animmgr.txt and a collinfo.txt (you can copy these from another treasure).
This is all you need to do to get the treasure working in game, however the piklopedia requires a bit more work.
go to \user\Matoba\resulttex\us\arc.szs and again create a folder with the name of your custom treasure. this is where you will but an icon for your treasure.
the icon should be a 32 x 32 bti image named texture.bti.
finally, go to \message\mesRes_<language>.szs and extract pikmin2.bmg using the bmg tool in ⁠pikmin-tools. there, you will add an entry for your treasure's in game name (this does not have to be the same name as the one in the filesystem) and also a piklopedia entry for your treasure. You should be all set at that point.

==Menu and HUD editing ==

BLO files, which house most of the screen resources, can be edited with pyblo2-gui. Often, positions of a UI element may be controlled by a BCK element, which can be edited in the animation part of the program.
BRK and BTK animations may also be involved,which can be edited with bark_conv and btk-conv respectively. BPK files can be edited with j3d-animation-editor.

==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. Review [https://docs.google.com/document/d/1UNhdBL3tYAn9sHO8gdOVJIpaHVo9_bbCLz7OazkEgZA/edit this document] to see what instruments you can use for your song depending on what bms you're replacing (if you're not editing wScenes with the Sound Modding Toolkit, that is)

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, wScene editing + creation, 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]]

Cutscene Editing and Creation

2025-10-19T22:22:49Z

Iwillremembermypasswordthistime: formatting

This page will run through editing and creating your own cutscenes in Pikmin 2. <br>
Cutscenes use the JStudio library, which was used in Wind Waker, Twilight Princess, Pikmin 2, and Skyward Sword.<br>
In Pikmin 2, cutscenes are contained in <code>demo.szs</code> files in <code>user/Mukki/movie</code>.<br>
Inside these szs files are a few assets, most notably the JStudio Binary (STB) file. This file controls initialization of cutscene data, as well as camera instructions.<br>
We can use a program called [https://drive.google.com/file/d/1JNqFF1IuJgdwzNA3XvVUEapyCwc2xfvP STB2JSON] to convert this to a more readable format.<br>

Note when extracting cutscene archives, you must use a program like WiiExplorer that can preserve the file indexes. This is because stb files load assets based in index, not by filename.<br>

<h1>STB Basics</h1>

STB files are separated into different "blocks" that can represent different "objects". The available blocks in the format are:

- JFVB (function value block)<br>
- JCMR (camera)<br>
- JABL (ambient light)<br>
- JACT (actor)<br>
- JSND (sound)<br>
- JLIT (light)<br>
- JCNT (control)<br>
- JMSG (message)<br>
- JFOG (fog)<br>
- JPTC (particle)<br>

Pikmin 2 only uses JFVB, JCMR, JCNT, JACT, JMSG, and JSND (which are the blocks that are going to be covered here), though the other blocks are theoretically supported. (note STB2JSON only supports the blocks vanilla uses) Particles are instead actors with a special identifier (an @ symbol in front of the name of the actor)

An object has both properties and variables, which control various things about that object.

Objects also have different "commands" to affect variables and properties of an object.<br>

The "VAR" command binds a value or function to a variable.<br>

* Its syntax is: <code>"VAR (VarName) (Value/function) (Data)"</code>

*The value/function types are:
** Void, to write a 0 to the variable
** Immediate, to write a direct value to the variable (specified in <code>(Data)</code>)
** Time, to write a direct value, that is multiplied by the number of frames since the last "WAIT" command multiplied by 0.03333333, to the variable (specified in <code>(Data)</code>)
** Index, to attach a JFVB function to the variable (the function index is specified in <code>(Data)</code>).

* A variable can affect more than one value of the bound object, in this case, the <code>(Data)</code> field will have more than 1 value.<br>

The "SET" command directly affects the properties of the bound object.<br>

* How you set a property is dependent on what the property is (hence they don't have a specific way of being set, unlike variables.) <br>

The "WAIT" command halts the execution of the object for a certain amount of frames.<br>
* After the delay of a "WAIT" command has passed, ALL value/functions will be unbound from the variables.

The "SYNC" command halts the execution of the object until an event, external to the STB, is fired.<br>

The "OFLG", "XFLG" and "AFLG" commands (respectively) OR/XOR/AND the stb flags with a value.<br>

An object's name is defined by the "Type" field.

The JFVB block is the only one that does not represent objects. Instead, it holds "functions" all that represent data and how it evolves over time. There are two main types of functions used: "Constant", which contains a value that never changes, and "Hermite", which contains a value that changes following Hermite interpolation.
This is where values such as animation translation data and camera coordinates are stored.

A group of values typically looks like this:
<pre>
{
"Func": "Hermite",
"Range": "0.0 12.966666",
"Data": [
[
"0.0",
"70.229546",
"0.0",
[
"12.966666",
"188.07487",
"0.0",
],
]
},</pre>

The range is typically the start and end frames of the movement, if the value is not a constant value. To convert between the time values in range and frames, divide the frame number by 0.03333333.<br>
in this example, 12.966666 becomes roughly frame 389. To convert frames to time, multiply by 0.03333333.

Each subgroup of values has three floats. The first one is the time, the second is the value of whatever you're putting (camera coordinates, animation translation data, etc), and the third is the tangent value for the hermite interpolation. Setting tangent values to 0.0 will result in a smooth ease.

<h1>Camera</h1>

Note when getting camera coordinates, the position coordinates and target coordinates will be relative to the origin of the cutscene's location (wherever it is activated). The origin of a cutscene is specified in <code>user/Mukki/movie/demos.txt</code>, and that value will need to be accounted for when getting coordinate values. <br>
Position flags are also important to note too.<br>

A position flag of 2 will use the origin and camera angle specified in <code>demos.txt</code> (both value are confusingly named origin in the file, but the origin is the one with three floats and the angle is the one with one float)<br>
A position flag of 4 or 8 will use the origin and camera angle specified in the code that plays the specific cutscene. (8 specifically will also try to get the best camera angle for the cutscene when played)<br>
A position flag of 16 will do the same as 4 & 8, in addition to taking into account the sound position of certain objects in the cutscene (specified in code)<br>

For this example, we will be using a cutscene <code>(x01_gamestart)</code> with an origin of <code>0.0, 0.0, 0.0</code>, and we will use the pikmin 2 gen editor to get coordinates, where values will be relative to <code>0.0, 0.0, 0.0</code> of the map's origin (which will serve as our cutscene origin, as the position flag is set to 2). (You can also use blender to get coordinates, which is especially helpful when using a custom map. This tutorial will use the gen editor, but Blender steps will be detailed later below.)<br>

Let's start making our stb. It's a good idea to start by getting a vanilla stb, and converting it to json, then editing our own values in.<br>
First, we're just doing camera, so delete everything aside from the JFVB and JCMR blocks.

To setup our camera block, input this information:

<pre>"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},</pre>

Setting the Type to "camera" will set the camera.<br>

Camera variables are:<br>

* ProjFovy - the field of view (FOV) of the camera. (float)
* ViewRoll - the rotation of the camera. (float)
* ViewPos - the XYZ position of the camera in the world. (float)
* TargPos - the XYZ position of where the camera is looking in the world. (float)
* Distance - the culling distance of the camera. It is usually set to <code>1.0 12800.0</code> (near distance, far distance) (float)

The indexes here correspond to values in the function value block. For instance, TargPos index 7 will have the Z coordinate of where the camera is looking take the values from the eighth group in the JFVB block.<br>
The index counts from 0.

Let's start setting some values. Our first value (ProjFovy) will be the FOV of our camera. We want to keep it a constant value, so well have our first FVB group look like this:
<pre>
{ (this is the bracket for the start of our JSON)
"JFVB": { (this is the bracket for the start of the JFVB block)
"Values": [ (this is the bracket for the start of all data values in the block)
{
"Func": "Constant",
"Data": "45.0",
},</pre>

Our next group will be rotation values. As before, we want to keep this constant.
<pre>
{
"Func": "Constant",
"Data": "0.0",
},</pre>

Our JSON should now look like this:
<pre>
{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},

}</pre>

Now it's time to get position coordinates from the gen editor. Open up the files for the valley of Repose, as that is the location of where our cutscene is.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage1.png
</gallery>
Place a reference object for the first set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage2.png
</gallery>
Copy the XYZ coordinates of the object into the JSON. They should be in the third (X), fourth (Y), and fifth (Z) set of values as Hermite functions. <br>
The first time value should be 0.0, for the start of the cutscene. Make sure the range is from frames 0 to 565 (converted to time).
<pre>
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
]
},</pre>

Place a reference object for the second set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage3.png
</gallery>
Copy the XYZ coordinates of the second object into the JSON as the second set in the value groups.
The time value should be 18.83333145 (frame 565), for the end of the cutscene.
<pre>{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},</pre>
Now for the target coordinates. It helps to move your position in the gen editor to one of your position reference objects, to get a betteer view of where you want your camera to look.<br>
Place a reference object for your target coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage4.png
</gallery>
We'll use a Constant function for the target, since we currently do not want where the camera is looking to change.
Copy the XYZ coordinates of the object into the JSON. They should be in the sixth (X), seventh (Y), and eighth (Z) set of values.<br>

<pre>{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
](this is the bracket for the end of all data values in the block)
},(this is the bracket for the end of the JFVB block)</pre>

This is what your JSON should look like now:

<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
}</pre>

Now you can save your JSON, use STB2JSON to convert it to STB, then repack the cutscene archive.
If everything was done correctly, it should look like this ingame:
<gallery mode="packed-hover" widths=400px heights=400px>
File:cutscene1.gif
</gallery>
If using Blender for coordinates, assuming your map is centered correctly, you can use the coordinates of Blender's camera for the cutscene coordinates.<br>
To convert between Blender coords and game coords, the X value remains the same, the Z coordinate in blender will be the Y coordinate in game, and the Y coordinate in blender should be multiplied by -1.<br>
Location XYZ will be ViewPos, and Rotation XYZ will be TargPos.<br>
<h1>Actors (and particles)</h1>

Actors are the most complicated part of cutscenes, so we'll need to break a few things down. <br>

There are four main types of actors:

Game Actors, which are certain creatures in the game world (like navis and onions). These are denoted with a <code>*</code> symbol in front of the actor's name. <br>
Special Actors, which are actors that can activate certain special functions in game. These are denoted with a <code>+</code> symbol in front of the actor's name. <br>
Particle Actors, which are particles. These are denoted with a <code>@</code> symbol in front of the actor's name. <br>
Actors, which are regular models placed in a cutscene. These are denoted with a <code>p</code> symbol in front of the actor's name, though this doesn't seem to be required. <br>

Sound effects are not part of the JACT block, but behave similarly to actors. These are denoted with a <code>#</code> symbol in front of the actor's name.

<h3>Game Actors</h3>

For Game Actors, each one has an identifier:

* <code>"theOrima"</code> is Olimar.
* <code>"theLouie"</code> is Louie/President.
* <code>"orimaAlive_1"</code> is the first alive leader.
* <code>"orimaAlive_2"</code> is the second alive leader.
* <code>"orimaDead_1"</code> is the first dead leader.
* <code>"orimaDead_2"</code> is the second dead leader.
* <code>"onyon_R"</code> is the Red Onion.
* <code>"onyon_Y"</code> is the Yellow Onion.
* <code>"onyon_B"</code> is the Blue Onion.
* <code>"ufo"</code> is the Hocotate Ship.
* <code>"pod"</code> is the Research Pod.
* <code>"pikmin"</code> is the target of the cutscene, if that target is a Pikmin.
* <code>"orima"</code> or "player" is the current active player.
* <code>"target</code>" is the target of the cutscene.

Game Actor variables are:

* Translation - the XYZ actor position offset from the movie position. (float)
* Rotation - the XYZ rotation of the actor relative to the actor's default orientation. Only the Y value seems to be used (float)

Game Actor properties are:

* AnimData
* Anim
* MovieTranslation

AnimData sets the index of the BCK data in the cutscene archive that will be applied to the creature it's set to affect. (int)
Anim sets which animation will be used. Setting Anim to "BCK" will use the BCK, while setting it to "None" will use the creature's base animation archive. (string)

Here's an example from the unused red onion boot cutscene <code>(g02_boot_onyonR)</code>:
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"SET MovieTranslation None",
"SET Anim None",
"SET AnimData 4",

</pre>

Here, Anim is set to None, so the animation will instead come from the onion's animations, and AnimData being set to 4 (counting from 0) will have the onion perform the fifth animation in the onion's <code>animmgr.txt</code>, which is <code>bootup.bck</code>.<br>

MovieTranslation defines how translation will be applied to the actor (string):

* "None" wont do anything,
* "Direct" will directly copy the translation to the actor position,
* "MinY" will directly copy the X and Z translations to the actor position, but set the Y position to the map's minimum Y,
* "FaceDir" will directly copy the translation to the actor position and copy the Y value of the Rotation variable to the direction the actor is facing,
* "MoviePos" will copy the movie position to the actor position.

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*theLouie",
"Commands": [
"VAR Translation Index 16 17 18",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 3",
"WAIT 70",
"VAR Translation Index 19 20 21",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 4",
"WAIT 350",
]
},</pre>
Here, our actor is <code>*theLouie</code> (Louie), the first set of translation (in this case, movement of Louie's model) coordinates come from the value groups at indexes 16, 17, 18 (counting from 0) in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fourth (0, 1, 2, 3) file in the archive as the animation.
<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage1.png
</gallery>
After waiting 70 frames (and after the textbox is cleared) the second set of translation coordinates come from the value groups at indexes 19, 20, 21 in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fifth (0, 1, 2, 3, 4) file in the archive as the animation.<br>

Translation coordinates can be obtained the same way as obtaining camera position coordinates. <br>

Onions (including the ship and pod), navis, underground cave holes, and geysers also have their own special properties that can be set. When these properties are set, special functions specific to that creature that can be executed. <br>

(note: the format for these identifiers is hex value/JSON name)<br>

Onions<br>

* 0x64/CreateHead1 - create sprout
* 0x65/Spot - starts onion/ship/pod spot effect
* 0x66/SpotState - stops onion/ship/pod spot effect
* 0x67/StartPropera - start ship propeller animation
* 0x68/StopPropera - stop ship propeller animation
* 0x69/CreateHead2 - create sprout

Navi <br>

* 0x64/EnterPikis - make Pikmin go into the onion/ship
* 0x66/HoleInPikis - make Pikmin go into a cave hole
* 0x67/FountainPikis - make Pikmin jump onto a geyser
* 0x68/DelShadow - hide leader shadow
* 0x69/DelParticles - hide leader particles
* 0x6a/AddParticles - show leader particles
* 0x6b/AddShadow - show leader shadow

Hole<br>

* 0x64 - make hole appear

Geyser

* 0x64 - make geyser appear

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"WAIT 105",
"SET CreateHead2",
"WAIT 315",
]
},</pre>

<h3>Particle Actors</h3>

Particle Actors are particles, getting their data from the <code>efx.jpc</code> included in the cutscene archive.

Particle actors have two properties:

* Parc - the particle ID (Short) and the particle list index (Byte) in the JPC.
* Targ - the object on which the particle will appear. If a second string is specified, the particle will appear on the object's model joint specified by the second string

Example:

<pre>"JACT": {
"Type": "@boot_gr_b",
"Commands": [
"SET Parc 5 5",
"SET Targ *onyon_R",
"WAIT 390",
]
},
"JACT": {
"Type": "@boot_gr_o",
"Commands": [
"SET Parc 6 5",
"SET Targ *onyon_R body_1",
"WAIT 390",
]
},</pre>

Particles have three variables:<br>

* Translation - XYZ position offset from the position of the object it is attached to, or the cutscene position if not attached to an object.(float)
* Rotation - XYZ rotation relative to the particle's default orientation(float)
* Scaling - XYZ size relative to the particle's default size(float)

If "ground" is the second string, the particle will uses the object position and ignore the object matrix.

<h3>Special Actors</h3>

Special Actors are actors whose can affect parts of the game. When a specific property of the special actor is set, the game will execute special functions depending on the property. They are usually context sensitive.<br>

The properties are:<br>

* 0x00/LeaveCave - abandon treasures and pikmin when giving up
* 0x01/DayEnd - create day end enemies, spawn left behind Pikmin
* 0x02/FallPikiSound - start falling Pikmin sound effects in cave entry
* 0x03/ForceEnterPiki - force Pikmin into the Onion on day 1
* 0x65/StartDemoCamera - start "demo" camera type (using the regular game camera instead of the cutscene camera)
* 0x66/EndDemoCamera - go back to normal player camera
* 0xC9/OpenKentei - open treasure collection UI (res_kantei)
* 0xCB/OpenKentei - open special item collection UI (res_special_item)
* 0x12D/FadeOut - fade the screen
* 0x12E/FadeIn - unfade the screen

Example:
<pre>"JACT": {
"Type": "+MovieCommand",
"Commands": [
"SET FallPikiSound",
"WAIT 219",
]
},</pre>

<h3>Actors</h3>

Actors are regular models that can appear in a cutscene.

Actor properties are:

* BCKIdx - sets the index of the BCK data in the cutscene archive that will be applied to the actor it's set to affect. (int)
* BMDIdx - sets the index of the BMD model the actor will use. (int)

Actor variables are

* Translation - the XYZ actor position offset from the movie position. (float)
* Scaling - the XYZ actor size relative to its default model size. (float)
* Rotation - the XYZ actor rotation relative to its default orientation. (float)<br>

Now that we've absorbed all that, let's add some actors to our cutscene.<br>

We're going to add Olimar, and have him play the down animation from <code>s03_orimadown</code>. We'll keep him stationary.

<pre>"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},</pre>

Note: because we don't have any translation going on here, olimar will be spawned where he would be spawned in regular gameplay.

<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage2.png
</gallery>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Actortutorialimage3.png
</gallery>

<h1>Sounds and messages</h1>

Message blocks are usually paired with a control block, presumably to halt things until the text box is done.<br>

<pre>"JMSG": {
"Type": "メッセージ",
"Commands": [
"WAIT 88",
"SET Code 894 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "コントロール",
"Commands": [
"WAIT 89",
"SYNC 1",
"WAIT 1",
]
},</pre>
The Type for messages is always "メッセージ" ("message"), and the Type for control is always "コントロール" ("control"). If there is more than one message/control in a cutscene, a number will follow the text (e.g. "メッセージ２" for the second message). Note that these aren't required, and currently, replacing the japanese text with english is needed for the rebuilding to not make a malformed STB.
Note the Code being set for the message block. The first three digits (short) are the message index (in decimal) in the [[BMG_file|BMG]]. The last digit (short) is the sub index of the message.

Sounds have two major components: Music, which is handled outside the STB, and sound effects, which for the most part are handled inside the STB.<br>

It's still worth mentioning some things about music:<br>

Which AST that is associated with which cutscene is controlled by <code>PSM::Demo::initiate</code> (in utilityU/PSMainSide_Demo.cpp) in the game's code. The function checks for a cutscene's name, then associates a stream file ID with it.

In vanilla, two cutscenes (<code>x20_blackman</code> and <code>x03_find_red_onyon</code>) are coded not to start with music initially. For the latter cutscene, audio is coded to start after the first text box has been closed.

Now about the other part of cutscene audio: Sound effects.<br>
This is what a typical sound block looks like:
<pre>"JSND": {
"Type": "#orimaAlive_2_1",
"Commands": [
"WAIT 335",
"SET Parent *orimaAlive_2",
"SET ParentNode happajnt3",
"SET ParentEnable True",
"SET Located True",
"SET ID 2161",
"SET BeginFadeIn 0.0",
"WAIT 12",
]
},</pre>

As stated earlier, a <code>#</code> in front of the name of the actor denotes a sound. <br>

Sound's properties are:

* Parent - binds the sound to an actor (in this case, the second alive player, or Louie) (string)
* ParentNode - further binds the sound to a specific joint on the model of the actor (string)
* ParentEnable - sets this binding to true. (boolean)
* Located - tells the sound to follow a position, whether from an attached creature or a direct position variable. (boolean)
* ID - the sound effect ID, in decimal. See [https://pikmintkb.com/wiki/Se.bms this page] for IDs. (int)
* Begin - starts the sound.
* BeginFadeIn - tells the sound to fade in when started, with the time it takes to fade in determined by the float after it.
* End - stops the sound.
* EndFadeOut - tells the sound to fade out when started, with the time it takes to fade out determined by the float after it.

Sound's variables are:

* Volume (float)
* Pan (float)
* Pitch (float)
* TempoProportion (float) - speed
* Fxmix (float) - reverb/echo
* Position (float) - XYZ sound position offset from the movie position

Let's add a sound effect and a text box to our cutscene.<br>

Text box first, we'll use message index 915 (in the BMG, this will show as hex, so it's actually 0x393) and have it appear at the end of the cutscene.

<pre>"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},</pre>

Due to a seemingly hardware dependent bug, the stb created by STB2JSON may have the "control block" represented as <code>0xEFBFBDEFBFBDEFBFBDEFBFBD</code> instead of <code>0xFFFFFFFF</code>, which is the correct one. If this happens, open your stb in a hex editor and change the offending bytes, making sure to delete the extra bytes.
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage1.png
</gallery>
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage2.png
</gallery>
Now let's test in game. <br>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Messagetutorialimage3.png
</gallery>

Finally, let's add a sound. Let's play <code>PSSE_SY_WMAP_MONEY_UP</code> (one of the ka-ching sounds)
We're not going to tie it to any actor, just have it play on its own.

<pre>"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},</pre>

Our whole JSON should now look like this:
<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},
"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},
"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},
}
</pre>
Convert your JSON to STB, remember to fix the control block if needed, repack your archive with WiiExplorer (make sure the file IDs are correct!), and play the cutscene in game.<br>

Congratulations, you have now made a full cutscene! Feel free to experiment with editing vanilla cutscenes, or making more of your own.

Cutscene Editing and Creation

2025-10-19T22:21:12Z

Iwillremembermypasswordthistime: clear up stuff about commands, properties and variables

This page will run through editing and creating your own cutscenes in Pikmin 2. <br>
Cutscenes use the JStudio library, which was used in Wind Waker, Twilight Princess, Pikmin 2, and Skyward Sword.<br>
In Pikmin 2, cutscenes are contained in <code>demo.szs</code> files in <code>user/Mukki/movie</code>.<br>
Inside these szs files are a few assets, most notably the JStudio Binary (STB) file. This file controls initialization of cutscene data, as well as camera instructions.<br>
We can use a program called [https://drive.google.com/file/d/1JNqFF1IuJgdwzNA3XvVUEapyCwc2xfvP STB2JSON] to convert this to a more readable format.<br>

Note when extracting cutscene archives, you must use a program like WiiExplorer that can preserve the file indexes. This is because stb files load assets based in index, not by filename.<br>

<h1>STB Basics</h1>

STB files are separated into different "blocks" that can represent different "objects". The available blocks in the format are:

- JFVB (function value block)<br>
- JCMR (camera)<br>
- JABL (ambient light)<br>
- JACT (actor)<br>
- JSND (sound)<br>
- JLIT (light)<br>
- JCNT (control)<br>
- JMSG (message)<br>
- JFOG (fog)<br>
- JPTC (particle)<br>

Pikmin 2 only uses JFVB, JCMR, JCNT, JACT, JMSG, and JSND (which are the blocks that are going to be covered here), though the other blocks are theoretically supported. (note STB2JSON only supports the blocks vanilla uses) Particles are instead actors with a special identifier (an @ symbol in front of the name of the actor)

An object has both properties and variables, which control various things about that object.

Objects also have different "commands" to affect variables and properties of an object.<br>

The "VAR" command binds a value or function to a variable.<br>

* Its syntax is:
* "VAR (VarName) (Value/function) (Data)",

*The value/function types are:
** Void, to write a 0 to the variable
** Immediate, to write a direct value to the variable (specified in (Data))
** Time, to write a direct value, that is multiplied by the number of frames since the last "WAIT" command multiplied by 0.03333333, to the variable (specified in (Data))
** Index, to attach a JFVB function to the variable (the function index is specified in (Data)).

* A variable can affect more than one value of the bound object, in this case, the (Data) field
* will have more than 1 value.<br>

The "SET" command directly affects the properties of the bound object.<br>

* How you set a property is dependent on what the property is (hence they don't have a specific way of being set, unlike variables.) <br>

The "WAIT" command halts the execution of the object for a certain amount of frames.<br>
* After the delay of a "WAIT" command has passed, ALL value/functions will be unbound from the variables.

The "SYNC" command halts the execution of the object until an event, external to the STB, is fired.<br>

The "OFLG", "XFLG" and "AFLG" commands (respectively) OR/XOR/AND the stb flags with a value.<br>

An object's name is defined by the "Type" field.

The JFVB block is the only one that does not represent objects. Instead, it holds "functions" all that represent data and how it evolves over time. There are two main types of functions used: "Constant", which contains a value that never changes, and "Hermite", which contains a value that changes following Hermite interpolation.
This is where values such as animation translation data and camera coordinates are stored.

A group of values typically looks like this:
<pre>
{
"Func": "Hermite",
"Range": "0.0 12.966666",
"Data": [
[
"0.0",
"70.229546",
"0.0",
[
"12.966666",
"188.07487",
"0.0",
],
]
},</pre>

The range is typically the start and end frames of the movement, if the value is not a constant value. To convert between the time values in range and frames, divide the frame number by 0.03333333.<br>
in this example, 12.966666 becomes roughly frame 389. To convert frames to time, multiply by 0.03333333.

Each subgroup of values has three floats. The first one is the time, the second is the value of whatever you're putting (camera coordinates, animation translation data, etc), and the third is the tangent value for the hermite interpolation. Setting tangent values to 0.0 will result in a smooth ease.

<h1>Camera</h1>

Note when getting camera coordinates, the position coordinates and target coordinates will be relative to the origin of the cutscene's location (wherever it is activated). The origin of a cutscene is specified in <code>user/Mukki/movie/demos.txt</code>, and that value will need to be accounted for when getting coordinate values. <br>
Position flags are also important to note too.<br>

A position flag of 2 will use the origin and camera angle specified in <code>demos.txt</code> (both value are confusingly named origin in the file, but the origin is the one with three floats and the angle is the one with one float)<br>
A position flag of 4 or 8 will use the origin and camera angle specified in the code that plays the specific cutscene. (8 specifically will also try to get the best camera angle for the cutscene when played)<br>
A position flag of 16 will do the same as 4 & 8, in addition to taking into account the sound position of certain objects in the cutscene (specified in code)<br>

For this example, we will be using a cutscene <code>(x01_gamestart)</code> with an origin of <code>0.0, 0.0, 0.0</code>, and we will use the pikmin 2 gen editor to get coordinates, where values will be relative to <code>0.0, 0.0, 0.0</code> of the map's origin (which will serve as our cutscene origin, as the position flag is set to 2). (You can also use blender to get coordinates, which is especially helpful when using a custom map. This tutorial will use the gen editor, but Blender steps will be detailed later below.)<br>

Let's start making our stb. It's a good idea to start by getting a vanilla stb, and converting it to json, then editing our own values in.<br>
First, we're just doing camera, so delete everything aside from the JFVB and JCMR blocks.

To setup our camera block, input this information:

<pre>"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},</pre>

Setting the Type to "camera" will set the camera.<br>

Camera variables are:<br>

* ProjFovy - the field of view (FOV) of the camera. (float)
* ViewRoll - the rotation of the camera. (float)
* ViewPos - the XYZ position of the camera in the world. (float)
* TargPos - the XYZ position of where the camera is looking in the world. (float)
* Distance - the culling distance of the camera. It is usually set to <code>1.0 12800.0</code> (near distance, far distance) (float)

The indexes here correspond to values in the function value block. For instance, TargPos index 7 will have the Z coordinate of where the camera is looking take the values from the eighth group in the JFVB block.<br>
The index counts from 0.

Let's start setting some values. Our first value (ProjFovy) will be the FOV of our camera. We want to keep it a constant value, so well have our first FVB group look like this:
<pre>
{ (this is the bracket for the start of our JSON)
"JFVB": { (this is the bracket for the start of the JFVB block)
"Values": [ (this is the bracket for the start of all data values in the block)
{
"Func": "Constant",
"Data": "45.0",
},</pre>

Our next group will be rotation values. As before, we want to keep this constant.
<pre>
{
"Func": "Constant",
"Data": "0.0",
},</pre>

Our JSON should now look like this:
<pre>
{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},

}</pre>

Now it's time to get position coordinates from the gen editor. Open up the files for the valley of Repose, as that is the location of where our cutscene is.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage1.png
</gallery>
Place a reference object for the first set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage2.png
</gallery>
Copy the XYZ coordinates of the object into the JSON. They should be in the third (X), fourth (Y), and fifth (Z) set of values as Hermite functions. <br>
The first time value should be 0.0, for the start of the cutscene. Make sure the range is from frames 0 to 565 (converted to time).
<pre>
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
]
},</pre>

Place a reference object for the second set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage3.png
</gallery>
Copy the XYZ coordinates of the second object into the JSON as the second set in the value groups.
The time value should be 18.83333145 (frame 565), for the end of the cutscene.
<pre>{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},</pre>
Now for the target coordinates. It helps to move your position in the gen editor to one of your position reference objects, to get a betteer view of where you want your camera to look.<br>
Place a reference object for your target coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage4.png
</gallery>
We'll use a Constant function for the target, since we currently do not want where the camera is looking to change.
Copy the XYZ coordinates of the object into the JSON. They should be in the sixth (X), seventh (Y), and eighth (Z) set of values.<br>

<pre>{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
](this is the bracket for the end of all data values in the block)
},(this is the bracket for the end of the JFVB block)</pre>

This is what your JSON should look like now:

<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
}</pre>

Now you can save your JSON, use STB2JSON to convert it to STB, then repack the cutscene archive.
If everything was done correctly, it should look like this ingame:
<gallery mode="packed-hover" widths=400px heights=400px>
File:cutscene1.gif
</gallery>
If using Blender for coordinates, assuming your map is centered correctly, you can use the coordinates of Blender's camera for the cutscene coordinates.<br>
To convert between Blender coords and game coords, the X value remains the same, the Z coordinate in blender will be the Y coordinate in game, and the Y coordinate in blender should be multiplied by -1.<br>
Location XYZ will be ViewPos, and Rotation XYZ will be TargPos.<br>
<h1>Actors (and particles)</h1>

Actors are the most complicated part of cutscenes, so we'll need to break a few things down. <br>

There are four main types of actors:

Game Actors, which are certain creatures in the game world (like navis and onions). These are denoted with a <code>*</code> symbol in front of the actor's name. <br>
Special Actors, which are actors that can activate certain special functions in game. These are denoted with a <code>+</code> symbol in front of the actor's name. <br>
Particle Actors, which are particles. These are denoted with a <code>@</code> symbol in front of the actor's name. <br>
Actors, which are regular models placed in a cutscene. These are denoted with a <code>p</code> symbol in front of the actor's name, though this doesn't seem to be required. <br>

Sound effects are not part of the JACT block, but behave similarly to actors. These are denoted with a <code>#</code> symbol in front of the actor's name.

<h3>Game Actors</h3>

For Game Actors, each one has an identifier:

* <code>"theOrima"</code> is Olimar.
* <code>"theLouie"</code> is Louie/President.
* <code>"orimaAlive_1"</code> is the first alive leader.
* <code>"orimaAlive_2"</code> is the second alive leader.
* <code>"orimaDead_1"</code> is the first dead leader.
* <code>"orimaDead_2"</code> is the second dead leader.
* <code>"onyon_R"</code> is the Red Onion.
* <code>"onyon_Y"</code> is the Yellow Onion.
* <code>"onyon_B"</code> is the Blue Onion.
* <code>"ufo"</code> is the Hocotate Ship.
* <code>"pod"</code> is the Research Pod.
* <code>"pikmin"</code> is the target of the cutscene, if that target is a Pikmin.
* <code>"orima"</code> or "player" is the current active player.
* <code>"target</code>" is the target of the cutscene.

Game Actor variables are:

* Translation - the XYZ actor position offset from the movie position. (float)
* Rotation - the XYZ rotation of the actor relative to the actor's default orientation. Only the Y value seems to be used (float)

Game Actor properties are:

* AnimData
* Anim
* MovieTranslation

AnimData sets the index of the BCK data in the cutscene archive that will be applied to the creature it's set to affect. (int)
Anim sets which animation will be used. Setting Anim to "BCK" will use the BCK, while setting it to "None" will use the creature's base animation archive. (string)

Here's an example from the unused red onion boot cutscene <code>(g02_boot_onyonR)</code>:
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"SET MovieTranslation None",
"SET Anim None",
"SET AnimData 4",

</pre>

Here, Anim is set to None, so the animation will instead come from the onion's animations, and AnimData being set to 4 (counting from 0) will have the onion perform the fifth animation in the onion's <code>animmgr.txt</code>, which is <code>bootup.bck</code>.<br>

MovieTranslation defines how translation will be applied to the actor (string):

* "None" wont do anything,
* "Direct" will directly copy the translation to the actor position,
* "MinY" will directly copy the X and Z translations to the actor position, but set the Y position to the map's minimum Y,
* "FaceDir" will directly copy the translation to the actor position and copy the Y value of the Rotation variable to the direction the actor is facing,
* "MoviePos" will copy the movie position to the actor position.

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*theLouie",
"Commands": [
"VAR Translation Index 16 17 18",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 3",
"WAIT 70",
"VAR Translation Index 19 20 21",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 4",
"WAIT 350",
]
},</pre>
Here, our actor is <code>*theLouie</code> (Louie), the first set of translation (in this case, movement of Louie's model) coordinates come from the value groups at indexes 16, 17, 18 (counting from 0) in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fourth (0, 1, 2, 3) file in the archive as the animation.
<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage1.png
</gallery>
After waiting 70 frames (and after the textbox is cleared) the second set of translation coordinates come from the value groups at indexes 19, 20, 21 in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fifth (0, 1, 2, 3, 4) file in the archive as the animation.<br>

Translation coordinates can be obtained the same way as obtaining camera position coordinates. <br>

Onions (including the ship and pod), navis, underground cave holes, and geysers also have their own special properties that can be set. When these properties are set, special functions specific to that creature that can be executed. <br>

(note: the format for these identifiers is hex value/JSON name)<br>

Onions<br>

* 0x64/CreateHead1 - create sprout
* 0x65/Spot - starts onion/ship/pod spot effect
* 0x66/SpotState - stops onion/ship/pod spot effect
* 0x67/StartPropera - start ship propeller animation
* 0x68/StopPropera - stop ship propeller animation
* 0x69/CreateHead2 - create sprout

Navi <br>

* 0x64/EnterPikis - make Pikmin go into the onion/ship
* 0x66/HoleInPikis - make Pikmin go into a cave hole
* 0x67/FountainPikis - make Pikmin jump onto a geyser
* 0x68/DelShadow - hide leader shadow
* 0x69/DelParticles - hide leader particles
* 0x6a/AddParticles - show leader particles
* 0x6b/AddShadow - show leader shadow

Hole<br>

* 0x64 - make hole appear

Geyser

* 0x64 - make geyser appear

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"WAIT 105",
"SET CreateHead2",
"WAIT 315",
]
},</pre>

<h3>Particle Actors</h3>

Particle Actors are particles, getting their data from the <code>efx.jpc</code> included in the cutscene archive.

Particle actors have two properties:

* Parc - the particle ID (Short) and the particle list index (Byte) in the JPC.
* Targ - the object on which the particle will appear. If a second string is specified, the particle will appear on the object's model joint specified by the second string

Example:

<pre>"JACT": {
"Type": "@boot_gr_b",
"Commands": [
"SET Parc 5 5",
"SET Targ *onyon_R",
"WAIT 390",
]
},
"JACT": {
"Type": "@boot_gr_o",
"Commands": [
"SET Parc 6 5",
"SET Targ *onyon_R body_1",
"WAIT 390",
]
},</pre>

Particles have three variables:<br>

* Translation - XYZ position offset from the position of the object it is attached to, or the cutscene position if not attached to an object.(float)
* Rotation - XYZ rotation relative to the particle's default orientation(float)
* Scaling - XYZ size relative to the particle's default size(float)

If "ground" is the second string, the particle will uses the object position and ignore the object matrix.

<h3>Special Actors</h3>

Special Actors are actors whose can affect parts of the game. When a specific property of the special actor is set, the game will execute special functions depending on the property. They are usually context sensitive.<br>

The properties are:<br>

* 0x00/LeaveCave - abandon treasures and pikmin when giving up
* 0x01/DayEnd - create day end enemies, spawn left behind Pikmin
* 0x02/FallPikiSound - start falling Pikmin sound effects in cave entry
* 0x03/ForceEnterPiki - force Pikmin into the Onion on day 1
* 0x65/StartDemoCamera - start "demo" camera type (using the regular game camera instead of the cutscene camera)
* 0x66/EndDemoCamera - go back to normal player camera
* 0xC9/OpenKentei - open treasure collection UI (res_kantei)
* 0xCB/OpenKentei - open special item collection UI (res_special_item)
* 0x12D/FadeOut - fade the screen
* 0x12E/FadeIn - unfade the screen

Example:
<pre>"JACT": {
"Type": "+MovieCommand",
"Commands": [
"SET FallPikiSound",
"WAIT 219",
]
},</pre>

<h3>Actors</h3>

Actors are regular models that can appear in a cutscene.

Actor properties are:

* BCKIdx - sets the index of the BCK data in the cutscene archive that will be applied to the actor it's set to affect. (int)
* BMDIdx - sets the index of the BMD model the actor will use. (int)

Actor variables are

* Translation - the XYZ actor position offset from the movie position. (float)
* Scaling - the XYZ actor size relative to its default model size. (float)
* Rotation - the XYZ actor rotation relative to its default orientation. (float)<br>

Now that we've absorbed all that, let's add some actors to our cutscene.<br>

We're going to add Olimar, and have him play the down animation from <code>s03_orimadown</code>. We'll keep him stationary.

<pre>"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},</pre>

Note: because we don't have any translation going on here, olimar will be spawned where he would be spawned in regular gameplay.

<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage2.png
</gallery>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Actortutorialimage3.png
</gallery>

<h1>Sounds and messages</h1>

Message blocks are usually paired with a control block, presumably to halt things until the text box is done.<br>

<pre>"JMSG": {
"Type": "メッセージ",
"Commands": [
"WAIT 88",
"SET Code 894 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "コントロール",
"Commands": [
"WAIT 89",
"SYNC 1",
"WAIT 1",
]
},</pre>
The Type for messages is always "メッセージ" ("message"), and the Type for control is always "コントロール" ("control"). If there is more than one message/control in a cutscene, a number will follow the text (e.g. "メッセージ２" for the second message). Note that these aren't required, and currently, replacing the japanese text with english is needed for the rebuilding to not make a malformed STB.
Note the Code being set for the message block. The first three digits (short) are the message index (in decimal) in the [[BMG_file|BMG]]. The last digit (short) is the sub index of the message.

Sounds have two major components: Music, which is handled outside the STB, and sound effects, which for the most part are handled inside the STB.<br>

It's still worth mentioning some things about music:<br>

Which AST that is associated with which cutscene is controlled by <code>PSM::Demo::initiate</code> (in utilityU/PSMainSide_Demo.cpp) in the game's code. The function checks for a cutscene's name, then associates a stream file ID with it.

In vanilla, two cutscenes (<code>x20_blackman</code> and <code>x03_find_red_onyon</code>) are coded not to start with music initially. For the latter cutscene, audio is coded to start after the first text box has been closed.

Now about the other part of cutscene audio: Sound effects.<br>
This is what a typical sound block looks like:
<pre>"JSND": {
"Type": "#orimaAlive_2_1",
"Commands": [
"WAIT 335",
"SET Parent *orimaAlive_2",
"SET ParentNode happajnt3",
"SET ParentEnable True",
"SET Located True",
"SET ID 2161",
"SET BeginFadeIn 0.0",
"WAIT 12",
]
},</pre>

As stated earlier, a <code>#</code> in front of the name of the actor denotes a sound. <br>

Sound's properties are:

* Parent - binds the sound to an actor (in this case, the second alive player, or Louie) (string)
* ParentNode - further binds the sound to a specific joint on the model of the actor (string)
* ParentEnable - sets this binding to true. (boolean)
* Located - tells the sound to follow a position, whether from an attached creature or a direct position variable. (boolean)
* ID - the sound effect ID, in decimal. See [https://pikmintkb.com/wiki/Se.bms this page] for IDs. (int)
* Begin - starts the sound.
* BeginFadeIn - tells the sound to fade in when started, with the time it takes to fade in determined by the float after it.
* End - stops the sound.
* EndFadeOut - tells the sound to fade out when started, with the time it takes to fade out determined by the float after it.

Sound's variables are:

* Volume (float)
* Pan (float)
* Pitch (float)
* TempoProportion (float) - speed
* Fxmix (float) - reverb/echo
* Position (float) - XYZ sound position offset from the movie position

Let's add a sound effect and a text box to our cutscene.<br>

Text box first, we'll use message index 915 (in the BMG, this will show as hex, so it's actually 0x393) and have it appear at the end of the cutscene.

<pre>"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},</pre>

Due to a seemingly hardware dependent bug, the stb created by STB2JSON may have the "control block" represented as <code>0xEFBFBDEFBFBDEFBFBDEFBFBD</code> instead of <code>0xFFFFFFFF</code>, which is the correct one. If this happens, open your stb in a hex editor and change the offending bytes, making sure to delete the extra bytes.
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage1.png
</gallery>
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage2.png
</gallery>
Now let's test in game. <br>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Messagetutorialimage3.png
</gallery>

Finally, let's add a sound. Let's play <code>PSSE_SY_WMAP_MONEY_UP</code> (one of the ka-ching sounds)
We're not going to tie it to any actor, just have it play on its own.

<pre>"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},</pre>

Our whole JSON should now look like this:
<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},
"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},
"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},
}
</pre>
Convert your JSON to STB, remember to fix the control block if needed, repack your archive with WiiExplorer (make sure the file IDs are correct!), and play the cutscene in game.<br>

Congratulations, you have now made a full cutscene! Feel free to experiment with editing vanilla cutscenes, or making more of your own.

Pikmin 2 directory tree

2025-10-19T19:32:21Z

Iwillremembermypasswordthistime: making sure no one tries deleting mizu.bti accidentally

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

{{todo|Add links for everything.}}

==GameCube==

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

==Wii==

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

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

Cutscene Editing and Creation

2025-10-18T14:43:24Z

Iwillremembermypasswordthistime: fixes

This page will run through editing and creating your own cutscenes in Pikmin 2. <br>
Cutscenes use the JStudio library, which was used in Wind Waker, Twilight Princess, Pikmin 2, and Skyward Sword.<br>
In Pikmin 2, cutscenes are contained in <code>demo.szs</code> files in <code>user/Mukki/movie</code>.<br>
Inside these szs files are a few assets, most notably the JStudio Binary (STB) file. This file controls initialization of cutscene data, as well as camera instructions.<br>
We can use a program called [https://drive.google.com/file/d/1JNqFF1IuJgdwzNA3XvVUEapyCwc2xfvP STB2JSON] to convert this to a more readable format.<br>

Note when extracting cutscene archives, you must use a program like WiiExplorer that can preserve the file indexes. This is because stb files load assets based in index, not by filename.<br>

<h1>STB Basics</h1>

STB files are separated into different "blocks" that can represent different "objects". The available blocks in the format are:

- JFVB (function value block)<br>
- JCMR (camera)<br>
- JABL (ambient light)<br>
- JACT (actor)<br>
- JSND (sound)<br>
- JLIT (light)<br>
- JCNT (control)<br>
- JMSG (message)<br>
- JFOG (fog)<br>
- JPTC (particle)<br>

Pikmin 2 only uses JFVB, JCMR, JCNT, JACT, JMSG, and JSND (which are the blocks that are going to be covered here), though the other blocks are theoretically supported. (note STB2JSON only supports the blocks vanilla uses) Particles are instead actors with a special identifier (an @ symbol in front of the name of the actor)

An object contains a list of "commands":

* "VAR" to bind a value/function to a variable
* "SET" to directly affect a properties of the bound object
* "WAIT" to halt the execution of the object for a certain amount of frames
* "SYNC" to halt the execution of the object until an event, external to the STB, is fired
* "OFLG", "XFLG" and "AFLG" to OR/XOR/AND the stb flags with a value

Each object has a set of "variables", which are bound to a properties of the object. A value/function can be bound to a variable using the "VAR" command:

"VAR (VarName) (Value/function) (Data)",

The value/function types are:

Void, to write a 0 to the variable<br>
Immediate, to write a direct value to the variable (specified in (Data))<br>
Time, to write a direct value, that is multiplied by the number of frames since the last "WAIT" command multiplied by 0.03333333, to the variable (specified in (Data))<br>
Index, to attach a JFVB function to the variable (the function index is specified in (Data)).<br>

A variable can affect more than one value of the bound object, in this case, the (Data) field
will have more than 1 value.<br>
After the delay of a "WAIT" command has passed, ALL value/function will be unbound from the
variables.

An object's name is defined by the "Type" field.

The JFVB block is the only one that does not represent objects. Instead, it holds "functions" all that represent data and how it evolves over time. There are two main types of functions used: "Constant", which contains a value that never changes, and "Hermite", which contains a value that changes following Hermite interpolation.
This is where values such as animation translation data and camera coordinates are stored.

A group of values typically looks like this:
<pre>
{
"Func": "Hermite",
"Range": "0.0 12.966666",
"Data": [
[
"0.0",
"70.229546",
"0.0",
[
"12.966666",
"188.07487",
"0.0",
],
]
},</pre>

The range is typically the start and end frames of the movement, if the value is not a constant value. To convert between the time values in range and frames, divide the frame number by 0.03333333.<br>
in this example, 12.966666 becomes roughly frame 389. To convert frames to time, multiply by 0.03333333.

Each subgroup of values has three floats. The first one is the time, the second is the value of whatever you're putting (camera coordinates, animation translation data, etc), and the third is the tangent value for the hermite interpolation. Setting tangent values to 0.0 will result in a smooth ease.

<h1>Camera</h1>

Note when getting camera coordinates, the position coordinates and target coordinates will be relative to the origin of the cutscene's location (wherever it is activated). The origin of a cutscene is specified in <code>user/Mukki/movie/demos.txt</code>, and that value will need to be accounted for when getting coordinate values. <br>
Position flags are also important to note too.<br>

A position flag of 2 will use the origin and camera angle specified in <code>demos.txt</code> (both value are confusingly named origin in the file, but the origin is the one with three floats and the angle is the one with one float)<br>
A position flag of 4 or 8 will use the origin and camera angle specified in the code that plays the specific cutscene. (8 specifically will also try to get the best camera angle for the cutscene when played)<br>
A position flag of 16 will do the same as 4 & 8, in addition to taking into account the sound position of certain objects in the cutscene (specified in code)<br>

For this example, we will be using a cutscene <code>(x01_gamestart)</code> with an origin of <code>0.0, 0.0, 0.0</code>, and we will use the pikmin 2 gen editor to get coordinates, where values will be relative to <code>0.0, 0.0, 0.0</code> of the map's origin (which will serve as our cutscene origin, as the position flag is set to 2). (You can also use blender to get coordinates, which is especially helpful when using a custom map. This tutorial will use the gen editor, but Blender steps will be detailed later below.)<br>

Let's start making our stb. It's a good idea to start by getting a vanilla stb, and converting it to json, then editing our own values in.<br>
First, we're just doing camera, so delete everything aside from the JFVB and JCMR blocks.

To setup our camera block, input this information:

<pre>"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},</pre>

Setting the Type to "camera" will set the camera.<br>

Camera variables are:<br>

* ProjFovy - the field of view (FOV) of the camera. (float)
* ViewRoll - the rotation of the camera. (float)
* ViewPos - the XYZ position of the camera in the world. (float)
* TargPos - the XYZ position of where the camera is looking in the world. (float)
* Distance - the culling distance of the camera. It is usually set to <code>1.0 12800.0</code> (near distance, far distance) (float)

The indexes here correspond to values in the function value block. For instance, TargPos index 7 will have the Z coordinate of where the camera is looking take the values from the eighth group in the JFVB block.<br>
The index counts from 0.

Let's start setting some values. Our first value (ProjFovy) will be the FOV of our camera. We want to keep it a constant value, so well have our first FVB group look like this:
<pre>
{ (this is the bracket for the start of our JSON)
"JFVB": { (this is the bracket for the start of the JFVB block)
"Values": [ (this is the bracket for the start of all data values in the block)
{
"Func": "Constant",
"Data": "45.0",
},</pre>

Our next group will be rotation values. As before, we want to keep this constant.
<pre>
{
"Func": "Constant",
"Data": "0.0",
},</pre>

Our JSON should now look like this:
<pre>
{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},

}</pre>

Now it's time to get position coordinates from the gen editor. Open up the files for the valley of Repose, as that is the location of where our cutscene is.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage1.png
</gallery>
Place a reference object for the first set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage2.png
</gallery>
Copy the XYZ coordinates of the object into the JSON. They should be in the third (X), fourth (Y), and fifth (Z) set of values as Hermite functions. <br>
The first time value should be 0.0, for the start of the cutscene. Make sure the range is from frames 0 to 565 (converted to time).
<pre>
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
]
},</pre>

Place a reference object for the second set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage3.png
</gallery>
Copy the XYZ coordinates of the second object into the JSON as the second set in the value groups.
The time value should be 18.83333145 (frame 565), for the end of the cutscene.
<pre>{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},</pre>
Now for the target coordinates. It helps to move your position in the gen editor to one of your position reference objects, to get a betteer view of where you want your camera to look.<br>
Place a reference object for your target coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage4.png
</gallery>
We'll use a Constant function for the target, since we currently do not want where the camera is looking to change.
Copy the XYZ coordinates of the object into the JSON. They should be in the sixth (X), seventh (Y), and eighth (Z) set of values.<br>

<pre>{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
](this is the bracket for the end of all data values in the block)
},(this is the bracket for the end of the JFVB block)</pre>

This is what your JSON should look like now:

<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
}</pre>

Now you can save your JSON, use STB2JSON to convert it to STB, then repack the cutscene archive.
If everything was done correctly, it should look like this ingame:
<gallery mode="packed-hover" widths=400px heights=400px>
File:cutscene1.gif
</gallery>
If using Blender for coordinates, assuming your map is centered correctly, you can use the coordinates of Blender's camera for the cutscene coordinates.<br>
To convert between Blender coords and game coords, the X value remains the same, the Z coordinate in blender will be the Y coordinate in game, and the Y coordinate in blender should be multiplied by -1.<br>
Location XYZ will be ViewPos, and Rotation XYZ will be TargPos.<br>
<h1>Actors (and particles)</h1>

Actors are the most complicated part of cutscenes, so we'll need to break a few things down. <br>

There are four main types of actors:

Game Actors, which are certain creatures in the game world (like navis and onions). These are denoted with a <code>*</code> symbol in front of the actor's name. <br>
Special Actors, which are actors that can activate certain commands. These are denoted with a <code>+</code> symbol in front of the actor's name. <br>
Particle Actors, which are particles. These are denoted with a <code>@</code> symbol in front of the actor's name. <br>
Actors, which are regular models placed in a cutscene. These are denoted with a <code>p</code> symbol in front of the actor's name, though this doesn't seem to be required. <br>

Sound effects are not part of the JACT block, but behave similarly to actors. These are denoted with a <code>#</code> symbol in front of the actor's name.

<h3>Game Actors</h3>

For Game Actors, each one has an identifier:

* <code>"theOrima"</code> is Olimar.
* <code>"theLouie"</code> is Louie/President.
* <code>"orimaAlive_1"</code> is the first alive leader.
* <code>"orimaAlive_2"</code> is the second alive leader.
* <code>"orimaDead_1"</code> is the first dead leader.
* <code>"orimaDead_2"</code> is the second dead leader.
* <code>"onyon_R"</code> is the Red Onion.
* <code>"onyon_Y"</code> is the Yellow Onion.
* <code>"onyon_B"</code> is the Blue Onion.
* <code>"ufo"</code> is the Hocotate Ship.
* <code>"pod"</code> is the Research Pod.
* <code>"pikmin"</code> is the target of the cutscene, if that target is a Pikmin.
* <code>"orima"</code> or "player" is the current active player.
* <code>"target</code>" is the target of the cutscene.

Game Actor variables are:

* Translation - the XYZ actor position offset from the movie position. (float)
* Rotation - the XYZ rotation of the actor relative to the actor's default orientation. Only the Y value seems to be used (float)

Game Actor properties are:

* AnimData
* Anim
* MovieTranslation

AnimData sets the index of the BCK data in the cutscene archive that will be applied to the creature it's set to affect. (int)
Anim sets which animation will be used. Setting Anim to "BCK" will use the BCK, while setting it to "None" will use the creature's base animation archive. (string)

Here's an example from the unused red onion boot cutscene <code>(g02_boot_onyonR)</code>:
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"SET MovieTranslation None",
"SET Anim None",
"SET AnimData 4",

</pre>

Here, Anim is set to None, so the animation will instead come from the onion's animations, and AnimData being set to 4 (counting from 0) will have the onion perform the fifth animation in the onion's <code>animmgr.txt</code>, which is <code>bootup.bck</code>.<br>

MovieTranslation defines how translation will be applied to the actor (string):

* "None" wont do anything,
* "Direct" will directly copy the translation to the actor position,
* "MinY" will directly copy the X and Z translations to the actor position, but set the Y position to the map's minimum Y,
* "FaceDir" will directly copy the translation to the actor position and copy the Y value of the Rotation variable to the direction the actor is facing,
* "MoviePos" will copy the movie position to the actor position.

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*theLouie",
"Commands": [
"VAR Translation Index 16 17 18",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 3",
"WAIT 70",
"VAR Translation Index 19 20 21",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 4",
"WAIT 350",
]
},</pre>
Here, our actor is <code>*theLouie</code> (Louie), the first set of translation (in this case, movement of Louie's model) coordinates come from the value groups at indexes 16, 17, 18 (counting from 0) in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fourth (0, 1, 2, 3) file in the archive as the animation.
<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage1.png
</gallery>
After waiting 70 frames (and after the textbox is cleared) the second set of translation coordinates come from the value groups at indexes 19, 20, 21 in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fifth (0, 1, 2, 3, 4) file in the archive as the animation.<br>

Translation coordinates can be obtained the same way as obtaining camera position coordinates. <br>

Onions (including the ship and pod), navis, underground cave holes, and geysers also have their own special properties that serve as commands that can be set. <br>

(note: the format for these identifiers is hex value/JSON name)<br>

Onions<br>

* 0x64/CreateHead1 - create sprout
* 0x65/Spot - starts onion/ship/pod spot effect
* 0x66/SpotState - stops onion/ship/pod spot effect
* 0x67/StartPropera - start ship propeller animation
* 0x68/StopPropera - stop ship propeller animation
* 0x69/CreateHead2 - create sprout

Navi <br>

* 0x64/EnterPikis - make Pikmin go into the onion/ship
* 0x66/HoleInPikis - make Pikmin go into a cave hole
* 0x67/FountainPikis - make Pikmin jump onto a geyser
* 0x68/DelShadow - hide leader shadow
* 0x69/DelParticles - hide leader particles
* 0x6a/AddParticles - show leader particles
* 0x6b/AddShadow - show leader shadow

Hole<br>

* 0x64 - make hole appear

Geyser

* 0x64 - make geyser appear

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"WAIT 105",
"SET CreateHead2",
"WAIT 315",
]
},</pre>

<h3>Particle Actors</h3>

Particle Actors are particles, getting their data from the <code>efx.jpc</code> included in the cutscene archive.

Particle actors have two properties:

* Parc - the particle ID (Short) and the particle list index (Byte) in the JPC.
* Targ - the object on which the particle will appear. If a second string is specified, the particle will appear on the object's model joint specified by the second string

Example:

<pre>"JACT": {
"Type": "@boot_gr_b",
"Commands": [
"SET Parc 5 5",
"SET Targ *onyon_R",
"WAIT 390",
]
},
"JACT": {
"Type": "@boot_gr_o",
"Commands": [
"SET Parc 6 5",
"SET Targ *onyon_R body_1",
"WAIT 390",
]
},</pre>

Particles have three variables:<br>

* Translation - XYZ position offset from the position of the object it is attached to, or the cutscene position if not attached to an object.(float)
* Rotation - XYZ rotation relative to the particle's default orientation(float)
* Scaling - XYZ size relative to the particle's default size(float)

If "ground" is the second string, the particle will uses the object position and ignore the object matrix.

<h3>Special Actors</h3>

Special Actors are actors that can affect parts of the game and execute special commands. They are usually context sensitive.<br>

The properties (commands) are:<br>

* 0x00/LeaveCave - abandon treasures and pikmin when giving up
* 0x01/DayEnd - create day end enemies, spawn left behind Pikmin
* 0x02/FallPikiSound - start falling Pikmin sound effects in cave entry
* 0x03/ForceEnterPiki - force Pikmin into the Onion on day 1
* 0x65/StartDemoCamera - start "demo" camera type (using the regular game camera instead of the cutscene camera)
* 0x66/EndDemoCamera - go back to normal player camera
* 0xC9/OpenKentei - open treasure collection UI (res_kantei)
* 0xCB/OpenKentei - open special item collection UI (res_special_item)
* 0x12D/FadeOut - fade the screen
* 0x12E/FadeIn - unfade the screen

Example:
<pre>"JACT": {
"Type": "+MovieCommand",
"Commands": [
"SET FallPikiSound",
"WAIT 219",
]
},</pre>

When the StartDemoCamera command is used, the cutscene will use the game's camera rather than the cutscene camera. This is mainly seen in <code>s03_orimadown</code>.

<h3>Actors</h3>

Actors are regular models that can appear in a cutscene.

Actor properties are:

* BCKIdx - sets the index of the BCK data in the cutscene archive that will be applied to the actor it's set to affect. (int)
* BMDIdx - sets the index of the BMD model the actor will use. (int)

Actor variables are

* Translation - the XYZ actor position offset from the movie position. (float)
* Scaling - the XYZ actor size relative to its default model size. (float)
* Rotation - the XYZ actor rotation relative to its default orientation. (float)<br>

Now that we've absorbed all that, let's add some actors to our cutscene.<br>

We're going to add Olimar, and have him play the down animation from <code>s03_orimadown</code>. We'll keep him stationary.

<pre>"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},</pre>

Note: because we don't have any translation going on here, olimar will be spawned where he would be spawned in regular gameplay.

<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage2.png
</gallery>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Actortutorialimage3.png
</gallery>

<h1>Sounds and messages</h1>

Message blocks are usually paired with a control block, presumably to halt things until the text box is done.<br>

<pre>"JMSG": {
"Type": "メッセージ",
"Commands": [
"WAIT 88",
"SET Code 894 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "コントロール",
"Commands": [
"WAIT 89",
"SYNC 1",
"WAIT 1",
]
},</pre>
The Type for messages is always "メッセージ" ("message"), and the Type for control is always "コントロール" ("control"). If there is more than one message/control in a cutscene, a number will follow the text (e.g. "メッセージ２" for the second message). Note that these aren't required, and currently, replacing the japanese text with english is needed for the rebuilding to not make a malformed STB.
Note the Code being set for the message block. The first three digits (short) are the message index (in decimal) in the [[BMG_file|BMG]]. The last digit (short) is the sub index of the message.

Sounds have two major components: Music, which is handled outside the STB, and sound effects, which for the most part are handled inside the STB.<br>

It's still worth mentioning some things about music:<br>

Which AST that is associated with which cutscene is controlled by <code>PSM::Demo::initiate</code> (in utilityU/PSMainSide_Demo.cpp) in the game's code. The function checks for a cutscene's name, then associates a stream file ID with it.

In vanilla, two cutscenes (<code>x20_blackman</code> and <code>x03_find_red_onyon</code>) are coded not to start with music initially. For the latter cutscene, audio is coded to start after the first text box has been closed.

Now about the other part of cutscene audio: Sound effects.<br>
This is what a typical sound block looks like:
<pre>"JSND": {
"Type": "#orimaAlive_2_1",
"Commands": [
"WAIT 335",
"SET Parent *orimaAlive_2",
"SET ParentNode happajnt3",
"SET ParentEnable True",
"SET Located True",
"SET ID 2161",
"SET BeginFadeIn 0.0",
"WAIT 12",
]
},</pre>

As stated earlier, a <code>#</code> in front of the name of the actor denotes a sound. <br>

Sound's properties are:

* Parent - binds the sound to an actor (in this case, the second alive player, or Louie) (string)
* ParentNode - further binds the sound to a specific joint on the model of the actor (string)
* ParentEnable - sets this binding to true. (boolean)
* Located - tells the sound to follow a position, whether from an attached creature or a direct position variable. (boolean)
* ID - the sound effect ID, in decimal. See [https://pikmintkb.com/wiki/Se.bms this page] for IDs. (int)
* Begin - starts the sound.
* BeginFadeIn - tells the sound to fade in when started, with the time it takes to fade in determined by the float after it.
* End - stops the sound.
* EndFadeOut - tells the sound to fade out when started, with the time it takes to fade out determined by the float after it.

Sound's variables are:

* Volume (float)
* Pan (float)
* Pitch (float)
* TempoProportion (float) - speed
* Fxmix (float) - reverb/echo
* Position (float) - XYZ sound position offset from the movie position

Let's add a sound effect and a text box to our cutscene.<br>

Text box first, we'll use message index 915 (in the BMG, this will show as hex, so it's actually 0x393) and have it appear at the end of the cutscene.

<pre>"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},</pre>

Due to a seemingly hardware dependent bug, the stb created by STB2JSON may have the "control block" represented as <code>0xEFBFBDEFBFBDEFBFBDEFBFBD</code> instead of <code>0xFFFFFFFF</code>, which is the correct one. If this happens, open your stb in a hex editor and change the offending bytes, making sure to delete the extra bytes.
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage1.png
</gallery>
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage2.png
</gallery>
Now let's test in game. <br>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Messagetutorialimage3.png
</gallery>

Finally, let's add a sound. Let's play <code>PSSE_SY_WMAP_MONEY_UP</code> (one of the ka-ching sounds)
We're not going to tie it to any actor, just have it play on its own.

<pre>"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},</pre>

Our whole JSON should now look like this:
<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},
"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},
"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},
}
</pre>
Convert your JSON to STB, remember to fix the control block if needed, repack your archive with WiiExplorer (make sure the file IDs are correct!), and play the cutscene in game.<br>

Congratulations, you have now made a full cutscene! Feel free to experiment with editing vanilla cutscenes, or making more of your own.

Cutscene Editing and Creation

2025-10-18T14:41:24Z

Iwillremembermypasswordthistime: blender steps added

This page will run through editing and creating your own cutscenes in Pikmin 2. <br>
Cutscenes use the JStudio library, which was used in Wind Waker, Twilight Princess, Pikmin 2, and Skyward Sword.<br>
In Pikmin 2, cutscenes are contained in <code>demo.szs</code> files in <code>user/Mukki/movie</code>.<br>
Inside these szs files are a few assets, most notably the JStudio Binary (STB) file. This file controls initialization of cutscene data, as well as camera instructions.<br>
We can use a program called [https://drive.google.com/file/d/1JNqFF1IuJgdwzNA3XvVUEapyCwc2xfvP STB2JSON] to convert this to a more readable format.<br>

Note when extracting cutscene archives, you must use a program like WiiExplorer that can preserve the file indexes. This is because stb files load assets based in index, not by filename.<br>

<h1>STB Basics</h1>

STB files are separated into different "blocks" that can represent different "objects". The available blocks in the format are:

- JFVB (function value block)<br>
- JCMR (camera)<br>
- JABL (ambient light)<br>
- JACT (actor)<br>
- JSND (sound)<br>
- JLIT (light)<br>
- JCNT (control)<br>
- JMSG (message)<br>
- JFOG (fog)<br>
- JPTC (particle)<br>

Pikmin 2 only uses JFVB, JCMR, JCNT, JACT, JMSG, and JSND (which are the blocks that are going to be covered here), though the other blocks are theoretically supported. (note STB2JSON only supports the blocks vanilla uses) Particles are instead actors with a special identifier (an @ symbol in front of the name of the actor)

An object contains a list of "commands":

* "VAR" to bind a value/function to a variable
* "SET" to directly affect a properties of the bound object
* "WAIT" to halt the execution of the object for a certain amount of frames
* "SYNC" to halt the execution of the object until an event, external to the STB, is fired
* "OFLG", "XFLG" and "AFLG" to OR/XOR/AND the stb flags with a value

Each object has a set of "variables", which are bound to a properties of the object. A value/function can be bound to a variable using the "VAR" command:

"VAR (VarName) (Value/function) (Data)",

The value/function types are:

Void, to write a 0 to the variable<br>
Immediate, to write a direct value to the variable (specified in (Data))<br>
Time, to write a direct value, that is multiplied by the number of frames since the last "WAIT" command multiplied by 0.03333333, to the variable (specified in (Data))<br>
Index, to attach a JFVB function to the variable (the function index is specified in (Data)).<br>

A variable can affect more than one value of the bound object, in this case, the (Data) field
will have more than 1 value.<br>
After the delay of a "WAIT" command has passed, ALL value/function will be unbound from the
variables.

An object's name is defined by the "Type" field.

The JFVB block is the only one that does not represent objects. Instead, it holds "functions" all that represent data and how it evolves over time. There are two main types of functions used: "Constant", which contains a value that never changes, and "Hermite", which contains a value that changes following Hermite interpolation.
This is where values such as animation translation data and camera coordinates are stored.

A group of values typically looks like this:
<pre>
{
"Func": "Hermite",
"Range": "0.0 12.966666",
"Data": [
[
"0.0",
"70.229546",
"0.0",
[
"12.966666",
"188.07487",
"0.0",
],
]
},</pre>

The range is typically the start and end frames of the movement, if the value is not a constant value. To convert between the time values in range and frames, divide the frame number by 0.03333333.<br>
in this example, 12.966666 becomes roughly frame 389. To convert frames to time, multiply by 0.03333333.

Each subgroup of values has three floats. The first one is the time, the second is the value of whatever you're putting (camera coordinates, animation translation data, etc), and the third is the tangent value for the hermite interpolation. Setting tangent values to 0.0 will result in a smooth ease.

<h1>Camera</h1>

Note when getting camera coordinates, the position coordinates and target coordinates will be relative to the origin of the cutscene's location (wherever it is activated). The origin of a cutscene is specified in <code>user/Mukki/movie/demos.txt</code>, and that value will need to be accounted for when getting coordinate values. <br>
Position flags are also important to note too.<br>

A position flag of 2 will use the origin and camera angle specified in <code>demos.txt</code> (both value are confusingly named origin in the file, but the origin is the one with three floats and the angle is the one with one float)<br>
A position flag of 4 or 8 will use the origin and camera angle specified in the code that plays the specific cutscene. (8 specifically will also try to get the best camera angle for the cutscene when played)<br>
A position flag of 16 will do the same as 4 & 8, in addition to taking into account the sound position of certain objects in the cutscene (specified in code)<br>

For this example, we will be using a cutscene <code>(x01_gamestart)</code> with an origin of <code>0.0, 0.0, 0.0</code>, and we will use the pikmin 2 gen editor to get coordinates, where values will be relative to <code>0.0, 0.0, 0.0</code> of the map's origin (which will serve as our cutscene origin, as the position flag is set to 2). (You can also use blender to get coordinates, which is especially helpful when using a custom map. This tutorial will use the gen editor, but Blender steps will be detailed later below.)
Let's start making our stb. It's a good idea to start by getting a vanilla stb, and converting it to json, then editing our own values in.<br>
First, we're just doing camera, so delete everything aside from the JFVB and JCMR blocks.

To setup our camera block, input this information:

<pre>"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},</pre>

Setting the Type to "camera" will set the camera.<br>

Camera variables are:<br>

* ProjFovy - the field of view (FOV) of the camera. (float)
* ViewRoll - the rotation of the camera. (float)
* ViewPos - the XYZ position of the camera in the world. (float)
* TargPos - the XYZ position of where the camera is looking in the world. (float)
* Distance - the culling distance of the camera. It is usually set to <code>1.0 12800.0</code> (near distance, far distance) (float)

The indexes here correspond to values in the function value block. For instance, TargPos index 7 will have the Z coordinate of where the camera is looking take the values from the eighth group in the JFVB block.<br>
The index counts from 0.

Let's start setting some values. Our first value (ProjFovy) will be the FOV of our camera. We want to keep it a constant value, so well have our first FVB group look like this:
<pre>
{ (this is the bracket for the start of our JSON)
"JFVB": { (this is the bracket for the start of the JFVB block)
"Values": [ (this is the bracket for the start of all data values in the block)
{
"Func": "Constant",
"Data": "45.0",
},</pre>

Our next group will be rotation values. As before, we want to keep this constant.
<pre>
{
"Func": "Constant",
"Data": "0.0",
},</pre>

Our JSON should now look like this:
<pre>
{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},

}</pre>

Now it's time to get position coordinates from the gen editor. Open up the files for the valley of Repose, as that is the location of where our cutscene is.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage1.png
</gallery>
Place a reference object for the first set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage2.png
</gallery>
Copy the XYZ coordinates of the object into the JSON. They should be in the third (X), fourth (Y), and fifth (Z) set of values as Hermite functions. <br>
The first time value should be 0.0, for the start of the cutscene. Make sure the range is from frames 0 to 565 (converted to time).
<pre>
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
]
},</pre>

Place a reference object for the second set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage3.png
</gallery>
Copy the XYZ coordinates of the second object into the JSON as the second set in the value groups.
The time value should be 18.83333145 (frame 565), for the end of the cutscene.
<pre>{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},</pre>
Now for the target coordinates. It helps to move your position in the gen editor to one of your position reference objects, to get a betteer view of where you want your camera to look.<br>
Place a reference object for your target coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage4.png
</gallery>
We'll use a Constant function for the target, since we currently do not want where the camera is looking to change.
Copy the XYZ coordinates of the object into the JSON. They should be in the sixth (X), seventh (Y), and eighth (Z) set of values.<br>

<pre>{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
](this is the bracket for the end of all data values in the block)
},(this is the bracket for the end of the JFVB block)</pre>

This is what your JSON should look like now:

<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
}</pre>

Now you can save your JSON, use STB2JSON to convert it to STB, then repack the cutscene archive.
If everything was done correctly, it should look like this ingame:
<gallery mode="packed-hover" widths=400px heights=400px>
File:cutscene1.gif
</gallery>
If using Blender for coordinates, assuming your map is centered correctly, you can use the coordinates of Blender's camera for the cutscene coordinates.<br>
To convert between Blender coords and game coords, the X value remains the same, the Z coordinate in blender will be the Y coordinate in game, and the Y coordinate in blender should be multiplied by -1.<br>
<h1>Actors (and particles)</h1>

Actors are the most complicated part of cutscenes, so we'll need to break a few things down. <br>

There are four main types of actors:

Game Actors, which are certain creatures in the game world (like navis and onions). These are denoted with a <code>*</code> symbol in front of the actor's name. <br>
Special Actors, which are actors that can activate certain commands. These are denoted with a <code>+</code> symbol in front of the actor's name. <br>
Particle Actors, which are particles. These are denoted with a <code>@</code> symbol in front of the actor's name. <br>
Actors, which are regular models placed in a cutscene. These are denoted with a <code>p</code> symbol in front of the actor's name, though this doesn't seem to be required. <br>

Sound effects are not part of the JACT block, but behave similarly to actors. These are denoted with a <code>#</code> symbol in front of the actor's name.

<h3>Game Actors</h3>

For Game Actors, each one has an identifier:

* <code>"theOrima"</code> is Olimar.
* <code>"theLouie"</code> is Louie/President.
* <code>"orimaAlive_1"</code> is the first alive leader.
* <code>"orimaAlive_2"</code> is the second alive leader.
* <code>"orimaDead_1"</code> is the first dead leader.
* <code>"orimaDead_2"</code> is the second dead leader.
* <code>"onyon_R"</code> is the Red Onion.
* <code>"onyon_Y"</code> is the Yellow Onion.
* <code>"onyon_B"</code> is the Blue Onion.
* <code>"ufo"</code> is the Hocotate Ship.
* <code>"pod"</code> is the Research Pod.
* <code>"pikmin"</code> is the target of the cutscene, if that target is a Pikmin.
* <code>"orima"</code> or "player" is the current active player.
* <code>"target</code>" is the target of the cutscene.

Game Actor variables are:

* Translation - the XYZ actor position offset from the movie position. (float)
* Rotation - the XYZ rotation of the actor relative to the actor's default orientation. Only the Y value seems to be used (float)

Game Actor properties are:

* AnimData
* Anim
* MovieTranslation

AnimData sets the index of the BCK data in the cutscene archive that will be applied to the creature it's set to affect. (int)
Anim sets which animation will be used. Setting Anim to "BCK" will use the BCK, while setting it to "None" will use the creature's base animation archive. (string)

Here's an example from the unused red onion boot cutscene <code>(g02_boot_onyonR)</code>:
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"SET MovieTranslation None",
"SET Anim None",
"SET AnimData 4",

</pre>

Here, Anim is set to None, so the animation will instead come from the onion's animations, and AnimData being set to 4 (counting from 0) will have the onion perform the fifth animation in the onion's <code>animmgr.txt</code>, which is <code>bootup.bck</code>.<br>

MovieTranslation defines how translation will be applied to the actor (string):

* "None" wont do anything,
* "Direct" will directly copy the translation to the actor position,
* "MinY" will directly copy the X and Z translations to the actor position, but set the Y position to the map's minimum Y,
* "FaceDir" will directly copy the translation to the actor position and copy the Y value of the Rotation variable to the direction the actor is facing,
* "MoviePos" will copy the movie position to the actor position.

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*theLouie",
"Commands": [
"VAR Translation Index 16 17 18",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 3",
"WAIT 70",
"VAR Translation Index 19 20 21",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 4",
"WAIT 350",
]
},</pre>
Here, our actor is <code>*theLouie</code> (Louie), the first set of translation (in this case, movement of Louie's model) coordinates come from the value groups at indexes 16, 17, 18 (counting from 0) in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fourth (0, 1, 2, 3) file in the archive as the animation.
<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage1.png
</gallery>
After waiting 70 frames (and after the textbox is cleared) the second set of translation coordinates come from the value groups at indexes 19, 20, 21 in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fifth (0, 1, 2, 3, 4) file in the archive as the animation.<br>

Translation coordinates can be obtained the same way as obtaining camera position coordinates. <br>

Onions (including the ship and pod), navis, underground cave holes, and geysers also have their own special properties that serve as commands that can be set. <br>

(note: the format for these identifiers is hex value/JSON name)<br>

Onions<br>

* 0x64/CreateHead1 - create sprout
* 0x65/Spot - starts onion/ship/pod spot effect
* 0x66/SpotState - stops onion/ship/pod spot effect
* 0x67/StartPropera - start ship propeller animation
* 0x68/StopPropera - stop ship propeller animation
* 0x69/CreateHead2 - create sprout

Navi <br>

* 0x64/EnterPikis - make Pikmin go into the onion/ship
* 0x66/HoleInPikis - make Pikmin go into a cave hole
* 0x67/FountainPikis - make Pikmin jump onto a geyser
* 0x68/DelShadow - hide leader shadow
* 0x69/DelParticles - hide leader particles
* 0x6a/AddParticles - show leader particles
* 0x6b/AddShadow - show leader shadow

Hole<br>

* 0x64 - make hole appear

Geyser

* 0x64 - make geyser appear

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"WAIT 105",
"SET CreateHead2",
"WAIT 315",
]
},</pre>

<h3>Particle Actors</h3>

Particle Actors are particles, getting their data from the <code>efx.jpc</code> included in the cutscene archive.

Particle actors have two properties:

* Parc - the particle ID (Short) and the particle list index (Byte) in the JPC.
* Targ - the object on which the particle will appear. If a second string is specified, the particle will appear on the object's model joint specified by the second string

Example:

<pre>"JACT": {
"Type": "@boot_gr_b",
"Commands": [
"SET Parc 5 5",
"SET Targ *onyon_R",
"WAIT 390",
]
},
"JACT": {
"Type": "@boot_gr_o",
"Commands": [
"SET Parc 6 5",
"SET Targ *onyon_R body_1",
"WAIT 390",
]
},</pre>

Particles have three variables:<br>

* Translation - XYZ position offset from the position of the object it is attached to, or the cutscene position if not attached to an object.(float)
* Rotation - XYZ rotation relative to the particle's default orientation(float)
* Scaling - XYZ size relative to the particle's default size(float)

If "ground" is the second string, the particle will uses the object position and ignore the object matrix.

<h3>Special Actors</h3>

Special Actors are actors that can affect parts of the game and execute special commands. They are usually context sensitive.<br>

The properties (commands) are:<br>

* 0x00/LeaveCave - abandon treasures and pikmin when giving up
* 0x01/DayEnd - create day end enemies, spawn left behind Pikmin
* 0x02/FallPikiSound - start falling Pikmin sound effects in cave entry
* 0x03/ForceEnterPiki - force Pikmin into the Onion on day 1
* 0x65/StartDemoCamera - start "demo" camera type (using the regular game camera instead of the cutscene camera)
* 0x66/EndDemoCamera - go back to normal player camera
* 0xC9/OpenKentei - open treasure collection UI (res_kantei)
* 0xCB/OpenKentei - open special item collection UI (res_special_item)
* 0x12D/FadeOut - fade the screen
* 0x12E/FadeIn - unfade the screen

Example:
<pre>"JACT": {
"Type": "+MovieCommand",
"Commands": [
"SET FallPikiSound",
"WAIT 219",
]
},</pre>

When the StartDemoCamera command is used, the cutscene will use the game's camera rather than the cutscene camera. This is mainly seen in <code>s03_orimadown</code>.

<h3>Actors</h3>

Actors are regular models that can appear in a cutscene.

Actor properties are:

* BCKIdx - sets the index of the BCK data in the cutscene archive that will be applied to the actor it's set to affect. (int)
* BMDIdx - sets the index of the BMD model the actor will use. (int)

Actor variables are

* Translation - the XYZ actor position offset from the movie position. (float)
* Scaling - the XYZ actor size relative to its default model size. (float)
* Rotation - the XYZ actor rotation relative to its default orientation. (float)<br>

Now that we've absorbed all that, let's add some actors to our cutscene.<br>

We're going to add Olimar, and have him play the down animation from <code>s03_orimadown</code>. We'll keep him stationary.

<pre>"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},</pre>

Note: because we don't have any translation going on here, olimar will be spawned where he would be spawned in regular gameplay.

<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage2.png
</gallery>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Actortutorialimage3.png
</gallery>

<h1>Sounds and messages</h1>

Message blocks are usually paired with a control block, presumably to halt things until the text box is done.<br>

<pre>"JMSG": {
"Type": "メッセージ",
"Commands": [
"WAIT 88",
"SET Code 894 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "コントロール",
"Commands": [
"WAIT 89",
"SYNC 1",
"WAIT 1",
]
},</pre>
The Type for messages is always "メッセージ" ("message"), and the Type for control is always "コントロール" ("control"). If there is more than one message/control in a cutscene, a number will follow the text (e.g. "メッセージ２" for the second message). Note that these aren't required, and currently, replacing the japanese text with english is needed for the rebuilding to not make a malformed STB.
Note the Code being set for the message block. The first three digits (short) are the message index (in decimal) in the [[BMG_file|BMG]]. The last digit (short) is the sub index of the message.

Sounds have two major components: Music, which is handled outside the STB, and sound effects, which for the most part are handled inside the STB.<br>

It's still worth mentioning some things about music:<br>

Which AST that is associated with which cutscene is controlled by <code>PSM::Demo::initiate</code> (in utilityU/PSMainSide_Demo.cpp) in the game's code. The function checks for a cutscene's name, then associates a stream file ID with it.

In vanilla, two cutscenes (<code>x20_blackman</code> and <code>x03_find_red_onyon</code>) are coded not to start with music initially. For the latter cutscene, audio is coded to start after the first text box has been closed.

Now about the other part of cutscene audio: Sound effects.<br>
This is what a typical sound block looks like:
<pre>"JSND": {
"Type": "#orimaAlive_2_1",
"Commands": [
"WAIT 335",
"SET Parent *orimaAlive_2",
"SET ParentNode happajnt3",
"SET ParentEnable True",
"SET Located True",
"SET ID 2161",
"SET BeginFadeIn 0.0",
"WAIT 12",
]
},</pre>

As stated earlier, a <code>#</code> in front of the name of the actor denotes a sound. <br>

Sound's properties are:

* Parent - binds the sound to an actor (in this case, the second alive player, or Louie) (string)
* ParentNode - further binds the sound to a specific joint on the model of the actor (string)
* ParentEnable - sets this binding to true. (boolean)
* Located - tells the sound to follow a position, whether from an attached creature or a direct position variable. (boolean)
* ID - the sound effect ID, in decimal. See [https://pikmintkb.com/wiki/Se.bms this page] for IDs. (int)
* Begin - starts the sound.
* BeginFadeIn - tells the sound to fade in when started, with the time it takes to fade in determined by the float after it.
* End - stops the sound.
* EndFadeOut - tells the sound to fade out when started, with the time it takes to fade out determined by the float after it.

Sound's variables are:

* Volume (float)
* Pan (float)
* Pitch (float)
* TempoProportion (float) - speed
* Fxmix (float) - reverb/echo
* Position (float) - XYZ sound position offset from the movie position

Let's add a sound effect and a text box to our cutscene.<br>

Text box first, we'll use message index 915 (in the BMG, this will show as hex, so it's actually 0x393) and have it appear at the end of the cutscene.

<pre>"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},</pre>

Due to a seemingly hardware dependent bug, the stb created by STB2JSON may have the "control block" represented as <code>0xEFBFBDEFBFBDEFBFBDEFBFBD</code> instead of <code>0xFFFFFFFF</code>, which is the correct one. If this happens, open your stb in a hex editor and change the offending bytes, making sure to delete the extra bytes.
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage1.png
</gallery>
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage2.png
</gallery>
Now let's test in game. <br>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Messagetutorialimage3.png
</gallery>

Finally, let's add a sound. Let's play <code>PSSE_SY_WMAP_MONEY_UP</code> (one of the ka-ching sounds)
We're not going to tie it to any actor, just have it play on its own.

<pre>"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},</pre>

Our whole JSON should now look like this:
<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},
"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},
"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},
}
</pre>
Convert your JSON to STB, remember to fix the control block if needed, repack your archive with WiiExplorer (make sure the file IDs are correct!), and play the cutscene in game.<br>

Congratulations, you have now made a full cutscene! Feel free to experiment with editing vanilla cutscenes, or making more of your own.

Pikmin 2 directory tree

2025-10-14T19:52:48Z

Iwillremembermypasswordthistime: corrections

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

{{todo|Add links for everything.}}

==GameCube==

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

==Wii==

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

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

Pikmin 2 troubleshooting

2025-09-18T19:36:24Z

Iwillremembermypasswordthistime: oops I forgot this

Solutions to common problems that can occur while editing ''Pikmin 2'''s files.

Note: Get the automatic crash debugger screen code listed below before continuing, as that crash screen can provide valuable info on what caused a crash.

<code>
Automatically Show Exception Handler (GameCube USA)
0442219c 60000000

Automatically Show Exception Handler (GameCube PAL)
04422440 60000000

Automatically Show Exception Handler (GameCube JPN)
04423ca0 60000000

Automatically Show Exception Handler (Wii USA)
044a803c 60000000

Automatically Show Exception Handler (GameCube USA Demo 1)
04422218 60000000
</code>

== Custom models ==
===My custom model has random stretchy bits ===
:Check your weight painting on the model, partial weights should not be used.

== Overworlds and Caves ==
=== The changes I made to the overworld aren't applying ===
:You need to create a new save

=== Adding more sublevels to a vanilla cave crashes ===
:Make sure the number of entries in the BgmList (located in <code>user/Totaka</code>) for the cave matches the number of sublevels that are in the cave.

=== Loading a cave stays stuck for longer than usual and eventually crashes Dolphin ===
:Open the [[cave definition file]] and go to the sublevel you were trying to load. Make sure that the amount of entries on <code>TekiInfo</code>, <code>ItemInfo</code>, etc. blocks matches the number present at the start of that same block (this number commented with <code>num</code>).

== Other common crashes ==
===The crash screen said "Memory Alloc Error"===
:That means the game is out of memory. Try reducing the size of a model, or the amount of enemies in an overworld, or whatever change you made that caused the error

[[Category:Pikmin 2]]
[[Category:Troubleshooting]]

Pikmin 2 area generator file

2025-09-10T19:02:35Z

Iwillremembermypasswordthistime: clarify

{{todo|Determine how the files in loop work, and verify that the information written regarding the gen files is correct.}}

An area's generator files can be found in <code>/user/Abe/map/*</code>. Amongst these, the <code>loop</code> and <code>nonloop</code> folders, as well as the <code>defaultgen.txt</code>, <code>initgen.txt</code>, and <code>plantsgen.txt</code> contain data for what objects to spawn in the area, and how. These text files must be encoded in Shift-JIS, or at least ASCII. To avoid any issues, use [https://notepad-plus-plus.org/download/v7.5.6.html Notepad++] and check the encoding in the bottom right.

The <code>loop</code> and <code>nonloop</code> folders have intriguing file-naming formats. They indicate a range of days, where the day numbering is one less than what day is displayed to players. For example, consider the following files in <code>tutorial/nonloop</code>:
<code>1-2.txt</code>, <code>1-4.txt</code>, <code>2-2.txt</code>, <code>3-9.txt</code>. On day 3, the entities in the first 3 files will run their generation procedure, but not the entities in <code>3-9.txt</code>. Files in <code>loop</code> will have their entities run their generation procedure on days matching up with the last digit. For example, entities in <code>1-4.txt</code> will run their generation procedure on days 12-15, 22-25, 32-35, and so on. Both <code>nonloop</code> and <code>loop</code> generators can have their days adjusted in <code>stages.txt</code>/<code>stages_(region).txt</code>.

===== Example =====
<pre>
# generatorMgr <Generator(Default)>
{v0.1} # version
0.000000 0.000000 0.000000 # startPos
0.000000 # startDir
34 # 34 generators
# 宇宙船
{
{v0.1} # version
0 # reserved
0 # 復活日数
137 70 146 136 145 68 0 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 # <宇宙船>
-331.454987 80.000000 1228.323975 # pos
0.000000 0.000000 0.000000 # offset
{item} {0002} # onyn
{
{onyn} # item id
0.000000 -171.524994 0.000000 # rotation
{0001} # item local version
4 # onyon index
1 # after boot? true==1
}
# gen base
{
{_eof}
}
}
</pre>

==Header==
Each file starts with a line titled <code># generatorMgr <Generator(Default)></code>. Under this is, <code>{v0.1}</code>, which denotes the format of the file. The coordinates next to <code>startPos</code> seem to be useless. Under <code>startDir</code> is a number (in this case 34, the number after the hashtag does NOT matter, as does anything else after a hashtag). This number must be the same as the number of entities listed in the file, or else the game will crash.

==Entity==
Underneath that in the brackets is the actual entity; in the above example, the Hocotate Ship. Everything above <code># pos</code> seems to be debug info for the original programmers with no effect on the entity(enemy or object) itself, EXCEPT for <code># reserved</code> which if set to zero, the object will only ever load once, and <code># 復活日数</code> underneath that, which controls how many days it takes to respawn(if set to zero, it will respawn always, even after leaving a cave). The numbers next to <code># pos</code> are the entity's x, y, and z coordinates. To find a point's coordinates in a level use 3ds Max or Yoshi2's Pikmin 2 Gen Editor. In <code># offset</code> are more x y z coordinates that will "offset" or move the entity over more by the amount specified. Under that is the Entity's class, for example <code>{item} {0002}</code>. Further still under that in the brackets is the <code># item id</code>. Finally, entities have 3 <code># rotation</code> values, to rotate it a number of degrees on the x, y, or z axis, respectively. To keep an object upright only change the y parameter. Under that lie the Entity's unique parameters.
There are multiple types of Entities in the Overworld, with differing parameters. These include...

==Entity categories==

# '''"{item} {0002}"'''
#* Includes the Hocotate Ship, the Onions, Caves, Weight Blocks, Paper Bags, Gates, Rock Clogs, Nectar Grass, Nectar Pebble, Bridges, Burgeoning Spiderwort, Spiderwort Mold, and the Ujadani.
# '''"{piki} {0001}"'''
#* Includes the main five types of Pikmin.
# '''{teki} {0005}'''
#* Includes all things in the Piklopedia/entities that can spawn in caves.
#* An enemy with a treasure in it is part of this group and has a value of that treasure + 768.
# '''{pelt} {0000}'''
#* Are exclusively treasures.

'''*Below, an x is used to denote where the variable is to be input in a parameter line.'''

{| class="wikitable sortable"
! Item ID || Parameters || Notes
|-
| {onyn} (onion/ship) || <code>x # onyon index</code><br><code>x # after boot? true==1</code> || index: 0=Blue Onion 1=Red Onion 2=Yellow Onion 4=Ship<br>after boot: 0 = wild Onion, only spawns if you haven't recruited that color; 1 = landing site, only spawns if you've already recruited that color
|-
| {piki} (wild Pikmin) || <code>{p000} 4 x</code><br><code># 色 {p001} 4 x </code><br><code># 数 {p002} 4 x</code><br><code># 自活(1=yes) {_eof} </code> || {p000} 0=Blue 1=Red 2=Yellow 3=Purple 4=White. Attempting to spawn Bulbmin or Pikpik carrots crashes the game.<br>{p001} x = number of Pikmin<br>{p002} 1 = wild Pikmin, 0 = unused, intended for an E3 version '''The fours are part of the code'''
|-
| {cave} (caves) || <code>x.txt</code><br><code>units.txt</code><br><code>{x_XX}</code><br><code># id (for stages.txt) </code><br><code># FogParm { {fg00} - {fg09} }</code> || First text file is the caveinfo file name; units.txt does nothing.<br>{x_XX} is the [[Pikmin_2_identifiers#Caves|cave ID]], used for name, hazard data, and various hardcoded boss behavior. The final digit of the ID is also the music index in BgmList.<br>{fg00} through {fg03} deal with fog zone start and end, how fast it starts and how long it lingers<br>{fg04} through {fg06} are the colors of the fog<br>{fg07} through {fg09} deal with the distances the fog spreads out when inside, when it appears, and when it disspates.<br>'''The fours are part of the code'''
|-
| {teki} (enemies, plants, and hazards) || [[#Teki|See below]] ||
|-
| {pelt} (carriable objects) || <code>X # mgr id</code><br><code>X.000000 X.000000 X.000000 # rotation</code><br><code>{0000} # pellet local version</code><br><code>XXX</code> || <code>mgr id</code> is the carriable object type: 0=pellets, 3=normal treasures, 4=Exploration Kit treasures. Other values are untested.<br>The line after <code>pellet local version</code> is the [[Pikmin 2 identifiers#Treasures|treasure ID]] for treasures.
|-
| {brdg} (stick bridges) || <code>x #橋タイプ</code> ||0 = short bridge 1 = sloped bridge 2 = long bridge
|-
| {gate} (bramble gates) || <code>x.000000 #ライフ </code><br><code>x #Color </code> ||First parameter is the gate's HP, second is the gate's color. 1 for black, 0 for white
|-
| {dgat} (electric gates) || <code>x.000000 #ライフ</code> ||The gate's health. Only comes in one color.
|-
| {rock} (spiderwort mold) || || Mold is actually called <code>{rock}</code> internally.
|-
| {barl} (rock clog) || || When destroyed, a clog will drain any waterbox it's placed inside; the waterbox is not specified here. Instead, the waterbox is specified in <code>waterbox.txt</code> A clogged cave entrance is simply a <code>{barl}</code> and <code>{cave}</code> at the same coordinates.
|-
| {plnt} (Burgeoning Spiderwort) || <code>x #実タイプ</code> ||What kind of berries it grows. 0=spicy 1=bitter 2=mixed.
|-
| {ujms} (Ujadani bugs) || <code>x #うじゃ王数</code> ||Number of bugs in the group.
|-
| {weed} (nectar grass/rocks) || <code>x #うじゃ王数 </code><br><code>x #石か草か</code> || <code>うじゃ王数</code>: amount of grass/rocks<br><code>石か草か</code>: 0=rocks, 1=grass
|-
| {dwfl} (downfloors: weight blocks and paper bags) || <code>x #沈み人数 </code><br><code>x #type </code><br><code>x # 1:seesaw</code><br><code>{XXXX} # id</code> || <code>沈み人数</code>: weight required to press. Only used if <code>1:seesaw</code> is 0. The weight is visible on seesaw blocks but has no effect.<br><code>type</code>: 0=small block, 1=large block, 2=paper bag<br><code>1:seesaw</code>: 0=press permanently, 1=seesaw.<br><code>id</code>: Only used for seesaw blocks. Set 2 blocks to the same ID to pair them.
|-
| {pkhd} (Sprout) || || Spawns a random color sprout.
|-
| {mitu} (Nectar) || || Spawns a nectar or spray.
|}

==Teki==

Entities in the Teki category have by far the most complex parameters of all types, and thus have their own section.

{{note|Note that certain teki will not drop treasures or pellets, even if set to do so. These include fire/electric/poison hazards, bomb rocks, Volatile Dweevils, eggs, Honeywisps, Candypops, and Spectralids. Pellet Posies are functional and can drop treasure/pellets in addition to their normal pellet.
Additionally, decorative plants and chiyogami paper can spawn a set of 4 yellow Spectralids when touched, if their pellet color is 0 and pellet size is 1. This is only fully functional for Margaret (ID 77) and red large Figwort (ID 50), but other plants can spawn Spectralids if one of the aforementioned plants is also present and set to spawn Spectralids.}}

{| class="wikitable sortable"
! Parameter || Notes
|-
| <code>x # teki</code> || The [[Pikmin 2 identifiers#Enemies_and_other_objects|Enemy's ID]].
|-
| <code>x # teki_birth_type</code> || 0 = Normal, 1 = Falls from the sky
|-
| <code>x # teki_num</code> || Number of enemies to spawn, used if <code># 0:point 1:circle</code> is >= 2.
|-
| <code>x.000000 # face direction</code> || Direction it faces, in degrees.
|-
| <code>x # 0:point 1:circle</code> || 1 or less = Single, 2 or more = Multiple
|-
| <code>x.000000 # appear radius</code> || Radius the enemy can spawn in, around the specified coordinates. Set to 0 to disable.
|-
| <code>x.000000 # enemy size</code> || Unknown
|-
| <code>x # お宝アイテムコード</code> || ID of treasure to drop. Add 768 for normal treasures, 1024 for Exploration Kit treasures.
|-
| <code>x # Pellet color</code> || Color of pellets to drop. 0 = Blue 1 = Red 2 = Yellow 3 = Random.
|-
| <code>x # Pellet size</code> || Size of dropped pellets; 1, 5, 10, or 20.
|-
| <code>x # Pellet Min</code> || Minimum number of pellets it can drop.
|-
| <code>x # Pellet Max</code> || Maximum number of pellets it can drop.
|-
| <code>x.xxxxxx # Pellet Min</code> || Different from the first, this controls the percent chance it will drop pellets. 1.0 is 100%
|-
| <code>x # pellet type</code> || Only used with Pellet Posies. Works just like the above <code># Pellet color</code>, except 3 = cycling between colors, and will crash if none of the primary colors are unlocked yet.
|-
| <code>x # pellet size</code> || Size of pellet it bears; only 1, 5, 10, or 20.
|-
| <code>x # size</code> || The stage of growth of the Pellet Posy. 0 = Sprout, 1 = Halfway, 2 = Mature.
|-
|}

{{credits| [[User:UnclePaul894|UnclePaul894]]}}

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

Pikmin 2 area generator file

2025-09-10T18:55:29Z

Iwillremembermypasswordthistime: loop

{{todo|Determine how the files in loop work, and verify that the information written regarding the gen files is correct.}}

An area's generator files can be found in <code>/user/Abe/map/*</code>. Amongst these, the <code>loop</code> and <code>nonloop</code> folders, as well as the <code>defaultgen.txt</code>, <code>initgen.txt</code>, and <code>plantsgen.txt</code> contain data for what objects to spawn in the area, and how. These text files must be encoded in Shift-JIS, or at least ASCII. To avoid any issues, use [https://notepad-plus-plus.org/download/v7.5.6.html Notepad++] and check the encoding in the bottom right.

The <code>loop</code> and <code>nonloop</code> folders have intriguing file-naming formats. They indicate a range of days, where the day numbering is one less than what day is displayed to players. For example, consider the following files in <code>tutorial/nonloop</code>:
<code>1-2.txt</code>, <code>1-4.txt</code>, <code>2-2.txt</code>, <code>3-9.txt</code>. On day 3, the entities in the first 3 files will run their generation procedure, but not the entities in <code>3-9.txt</code>. Files in <code>loop</code> will have their entities run their generation procedure on days matching up with the last digit. For example, entities in <code>1-4.txt</code> will run their generation procedure on days 12-15, 22-25, 32-35, and so on. Both <code>nonloop</code> and <code>loop</code> generators can have their days adjusted in <code>stages_(region).txt</code>.

===== Example =====
<pre>
# generatorMgr <Generator(Default)>
{v0.1} # version
0.000000 0.000000 0.000000 # startPos
0.000000 # startDir
34 # 34 generators
# 宇宙船
{
{v0.1} # version
0 # reserved
0 # 復活日数
137 70 146 136 145 68 0 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 205 # <宇宙船>
-331.454987 80.000000 1228.323975 # pos
0.000000 0.000000 0.000000 # offset
{item} {0002} # onyn
{
{onyn} # item id
0.000000 -171.524994 0.000000 # rotation
{0001} # item local version
4 # onyon index
1 # after boot? true==1
}
# gen base
{
{_eof}
}
}
</pre>

==Header==
Each file starts with a line titled <code># generatorMgr <Generator(Default)></code>. Under this is, <code>{v0.1}</code>, which denotes the format of the file. The coordinates next to <code>startPos</code> seem to be useless. Under <code>startDir</code> is a number (in this case 34, the number after the hashtag does NOT matter, as does anything else after a hashtag). This number must be the same as the number of entities listed in the file, or else the game will crash.

==Entity==
Underneath that in the brackets is the actual entity; in the above example, the Hocotate Ship. Everything above <code># pos</code> seems to be debug info for the original programmers with no effect on the entity(enemy or object) itself, EXCEPT for <code># reserved</code> which if set to zero, the object will only ever load once, and <code># 復活日数</code> underneath that, which controls how many days it takes to respawn(if set to zero, it will respawn always, even after leaving a cave). The numbers next to <code># pos</code> are the entity's x, y, and z coordinates. To find a point's coordinates in a level use 3ds Max or Yoshi2's Pikmin 2 Gen Editor. In <code># offset</code> are more x y z coordinates that will "offset" or move the entity over more by the amount specified. Under that is the Entity's class, for example <code>{item} {0002}</code>. Further still under that in the brackets is the <code># item id</code>. Finally, entities have 3 <code># rotation</code> values, to rotate it a number of degrees on the x, y, or z axis, respectively. To keep an object upright only change the y parameter. Under that lie the Entity's unique parameters.
There are multiple types of Entities in the Overworld, with differing parameters. These include...

==Entity categories==

# '''"{item} {0002}"'''
#* Includes the Hocotate Ship, the Onions, Caves, Weight Blocks, Paper Bags, Gates, Rock Clogs, Nectar Grass, Nectar Pebble, Bridges, Burgeoning Spiderwort, Spiderwort Mold, and the Ujadani.
# '''"{piki} {0001}"'''
#* Includes the main five types of Pikmin.
# '''{teki} {0005}'''
#* Includes all things in the Piklopedia/entities that can spawn in caves.
#* An enemy with a treasure in it is part of this group and has a value of that treasure + 768.
# '''{pelt} {0000}'''
#* Are exclusively treasures.

'''*Below, an x is used to denote where the variable is to be input in a parameter line.'''

{| class="wikitable sortable"
! Item ID || Parameters || Notes
|-
| {onyn} (onion/ship) || <code>x # onyon index</code><br><code>x # after boot? true==1</code> || index: 0=Blue Onion 1=Red Onion 2=Yellow Onion 4=Ship<br>after boot: 0 = wild Onion, only spawns if you haven't recruited that color; 1 = landing site, only spawns if you've already recruited that color
|-
| {piki} (wild Pikmin) || <code>{p000} 4 x</code><br><code># 色 {p001} 4 x </code><br><code># 数 {p002} 4 x</code><br><code># 自活(1=yes) {_eof} </code> || {p000} 0=Blue 1=Red 2=Yellow 3=Purple 4=White. Attempting to spawn Bulbmin or Pikpik carrots crashes the game.<br>{p001} x = number of Pikmin<br>{p002} 1 = wild Pikmin, 0 = unused, intended for an E3 version '''The fours are part of the code'''
|-
| {cave} (caves) || <code>x.txt</code><br><code>units.txt</code><br><code>{x_XX}</code><br><code># id (for stages.txt) </code><br><code># FogParm { {fg00} - {fg09} }</code> || First text file is the caveinfo file name; units.txt does nothing.<br>{x_XX} is the [[Pikmin_2_identifiers#Caves|cave ID]], used for name, hazard data, and various hardcoded boss behavior. The final digit of the ID is also the music index in BgmList.<br>{fg00} through {fg03} deal with fog zone start and end, how fast it starts and how long it lingers<br>{fg04} through {fg06} are the colors of the fog<br>{fg07} through {fg09} deal with the distances the fog spreads out when inside, when it appears, and when it disspates.<br>'''The fours are part of the code'''
|-
| {teki} (enemies, plants, and hazards) || [[#Teki|See below]] ||
|-
| {pelt} (carriable objects) || <code>X # mgr id</code><br><code>X.000000 X.000000 X.000000 # rotation</code><br><code>{0000} # pellet local version</code><br><code>XXX</code> || <code>mgr id</code> is the carriable object type: 0=pellets, 3=normal treasures, 4=Exploration Kit treasures. Other values are untested.<br>The line after <code>pellet local version</code> is the [[Pikmin 2 identifiers#Treasures|treasure ID]] for treasures.
|-
| {brdg} (stick bridges) || <code>x #橋タイプ</code> ||0 = short bridge 1 = sloped bridge 2 = long bridge
|-
| {gate} (bramble gates) || <code>x.000000 #ライフ </code><br><code>x #Color </code> ||First parameter is the gate's HP, second is the gate's color. 1 for black, 0 for white
|-
| {dgat} (electric gates) || <code>x.000000 #ライフ</code> ||The gate's health. Only comes in one color.
|-
| {rock} (spiderwort mold) || || Mold is actually called <code>{rock}</code> internally.
|-
| {barl} (rock clog) || || When destroyed, a clog will drain any waterbox it's placed inside; the waterbox is not specified here. Instead, the waterbox is specified in <code>waterbox.txt</code> A clogged cave entrance is simply a <code>{barl}</code> and <code>{cave}</code> at the same coordinates.
|-
| {plnt} (Burgeoning Spiderwort) || <code>x #実タイプ</code> ||What kind of berries it grows. 0=spicy 1=bitter 2=mixed.
|-
| {ujms} (Ujadani bugs) || <code>x #うじゃ王数</code> ||Number of bugs in the group.
|-
| {weed} (nectar grass/rocks) || <code>x #うじゃ王数 </code><br><code>x #石か草か</code> || <code>うじゃ王数</code>: amount of grass/rocks<br><code>石か草か</code>: 0=rocks, 1=grass
|-
| {dwfl} (downfloors: weight blocks and paper bags) || <code>x #沈み人数 </code><br><code>x #type </code><br><code>x # 1:seesaw</code><br><code>{XXXX} # id</code> || <code>沈み人数</code>: weight required to press. Only used if <code>1:seesaw</code> is 0. The weight is visible on seesaw blocks but has no effect.<br><code>type</code>: 0=small block, 1=large block, 2=paper bag<br><code>1:seesaw</code>: 0=press permanently, 1=seesaw.<br><code>id</code>: Only used for seesaw blocks. Set 2 blocks to the same ID to pair them.
|-
| {pkhd} (Sprout) || || Spawns a random color sprout.
|-
| {mitu} (Nectar) || || Spawns a nectar or spray.
|}

==Teki==

Entities in the Teki category have by far the most complex parameters of all types, and thus have their own section.

{{note|Note that certain teki will not drop treasures or pellets, even if set to do so. These include fire/electric/poison hazards, bomb rocks, Volatile Dweevils, eggs, Honeywisps, Candypops, and Spectralids. Pellet Posies are functional and can drop treasure/pellets in addition to their normal pellet.
Additionally, decorative plants and chiyogami paper can spawn a set of 4 yellow Spectralids when touched, if their pellet color is 0 and pellet size is 1. This is only fully functional for Margaret (ID 77) and red large Figwort (ID 50), but other plants can spawn Spectralids if one of the aforementioned plants is also present and set to spawn Spectralids.}}

{| class="wikitable sortable"
! Parameter || Notes
|-
| <code>x # teki</code> || The [[Pikmin 2 identifiers#Enemies_and_other_objects|Enemy's ID]].
|-
| <code>x # teki_birth_type</code> || 0 = Normal, 1 = Falls from the sky
|-
| <code>x # teki_num</code> || Number of enemies to spawn, used if <code># 0:point 1:circle</code> is >= 2.
|-
| <code>x.000000 # face direction</code> || Direction it faces, in degrees.
|-
| <code>x # 0:point 1:circle</code> || 1 or less = Single, 2 or more = Multiple
|-
| <code>x.000000 # appear radius</code> || Radius the enemy can spawn in, around the specified coordinates. Set to 0 to disable.
|-
| <code>x.000000 # enemy size</code> || Unknown
|-
| <code>x # お宝アイテムコード</code> || ID of treasure to drop. Add 768 for normal treasures, 1024 for Exploration Kit treasures.
|-
| <code>x # Pellet color</code> || Color of pellets to drop. 0 = Blue 1 = Red 2 = Yellow 3 = Random.
|-
| <code>x # Pellet size</code> || Size of dropped pellets; 1, 5, 10, or 20.
|-
| <code>x # Pellet Min</code> || Minimum number of pellets it can drop.
|-
| <code>x # Pellet Max</code> || Maximum number of pellets it can drop.
|-
| <code>x.xxxxxx # Pellet Min</code> || Different from the first, this controls the percent chance it will drop pellets. 1.0 is 100%
|-
| <code>x # pellet type</code> || Only used with Pellet Posies. Works just like the above <code># Pellet color</code>, except 3 = cycling between colors, and will crash if none of the primary colors are unlocked yet.
|-
| <code>x # pellet size</code> || Size of pellet it bears; only 1, 5, 10, or 20.
|-
| <code>x # size</code> || The stage of growth of the Pellet Posy. 0 = Sprout, 1 = Halfway, 2 = Mature.
|-
|}

{{credits| [[User:UnclePaul894|UnclePaul894]]}}

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

Drought Enders Cave Creator

2025-09-07T14:43:30Z

Iwillremembermypasswordthistime: ever heard of a fucking README

__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}}

PikiParms

2025-09-05T08:53:18Z

Iwillremembermypasswordthistime: explain some parameters

NOTICE: This is a MAJOR work in progress.

Located in <code>/user/Abe/piki</code> pikiParms.txt is parameter settings for the Pikmin. Below is the file, along with some notes explaining what the values are.

{{todo|For Fp 04 (the second one) through Fp 09, explain, I don't know what playback frames are}}

{|class="wikitable sortable mw-collapsible"
! pikiParms.txt
<div align="left"><source lang="powershell">
# Creature :: Property (Standard Parameters, also seen in enemy files)
{
{S000} 4 0.100000 # friction (not used)
{S001} 4 0.500000 # wallReflection
{S002} 4 0.800000 # faceDirAdjust
{S003} 4 0.140000 # accel
{S004} 4 0.300000 # bounceFactor
{_ Eof}
}
# FakePiki :: Parms (Settings for both Pikmin and Leaders? Not sure)
{
{Fp 01} 4 5.000000 # ASIBUMI start speed (Fp 01 through the first 04 should be pretty self-explanitory)
{Fp 02} 4 8.000000 # WALK start speed
{Fp 03} 4 20.000000 # RUN start speed
{Fp 04} 4 60.000000 # ESCAPE start speed
{Fp 04} 4 60.000000 # WALK Number of playback frames (min)
{Fp 05} 4 50.000000 # WALK Number of playback frames (max)
{Fp 06} 4 40.000000 # RUN Number of playback frames (min)
{Fp 07} 4 60.000000 # RUN Number of playback frames (max)
{Fp 08} 4 60.000000 # ESCAPE Number of playback frames (min)
{Fp 09} 4 100.000000 # ESCAPE Number of playback frames (max)
{_ Eof}
{}
# Piki :: Parms (Normal Pikmin settings, if there's no explanation added by an editor on this wiki, it's probably self-explanitory)
{
{P000} 4 10.000000 # walking speed
{P001} 4 120.000000 # Running speed
{P054} 4 170.000000 # Flower Piki Speed
{P065} 4 140.000000 # Bud Speed
{P038} 4 1.000000 # Piki display scale (Size paremeters?)
{P003} 4 100.000000 # Standard Life (This and the two next ones are probably HP settings)
{P010} 4 150.000000 # Tail Life
{P011} 4 200.000000 # Life in
{P004} 4 10.000000 # Blue Attack Power (Also Bulbmin Attack Power)
{P012} 4 15.000000 # Red Attack Power
{P013} 4 10.000000 # Yellow Attack Power
{P003} 4 20.000000 # Black attack power (Purples are known as Black Pikmin internally)
{P004} 4 10.000000 # White attack power
{P005} 4 1 # energy required for buds (?)
{P006} 4 1 # Number of energy required for flowers (?)
{P007} 4 0.800000 # Scale of Normal Piki (more size settings?)
{P008} 4 1.500000 # The scale of the huge Piki (Captain size settings?)
{P009} 4 1.200000 # Fatty Piki's scale (Purple Pikmin size settings, probably)
{P014} 4 2.500000 # Total collapse time (Total time a pikmin is on the ground after tripping, before getting back up)
{P015} 4 1.000000 # Petankko time (?)
{P016} 4 0.900000 # Wave time (probably for the Purple Pikmin)
{P037} 4 35.000000 # Wave Attac attack range
{P017} 4 5.000000 # ASIBUMI start speed
{P018} 4 35.000000 # WALK start speed
{P019} 4 70.000000 # RUN start speed
{P020} 4 160.000000 # ESCAPE start speed
{P021} 4 30.000000 # WALK Number of playback frames (min)
{P022} 4 60.000000 # WALK Number of playback frames (max)
{P023} 4 30.000000 # RUN Number of playback frames (min)
{P024} 4 60.000000 # RUN Number of playback frames (max)
{P025} 4 30.000000 # Number of ESCAPE playback frames (min)
{P026} 4 60.000000 # ESCAPE Number of playback frames (max)
{P027} 4 3.000000 # per size (min)
{P034} 4 5.000000 # per size (max)
{P028} 4 100.000000 # reciprocal of weight (this and the next 6 don't have known functions)
{P039} 4 8.500000 # size per ground
{P029} 4 600.000000 # white distance
{P030} 4 1000.000000 # gray Distance
{P031} 4 10.000000 # Lost child time
{P032} 4 50.000000 # white distance (Free)
{P033} 4 250.000000 # gray Distance (Free)
{P035} 4 2.000000 # Time to start pushing wall (Dynamic)
{P036} 4 2.000000 # Time to start pushing the wall (Static)
{P040} 4 120.000000 # Time to free (?)
{P041} 4 70.000000 # Distance to look for enemies to attack
{P042} 4 55.000000 # Distance to look for pellets to carry
{P010} 4 45.000000 # Distance to look for nectar rock to attack
{P011} 4 45.000000 # Distance to look for nectar rock to attack
{P012} 4 60.000000 # Distance to look for bridge to work on
{P013} 4 45.000000 # Distance to look for clog to attack
{P014} 4 45.000000 # Distance to look for buried treasure to dig up
{P015} 4 45.000000 # Distance to look for spiderworts to harvest from
{P043} 4 3.000000 # Maximum time recover from being knocked down
{P074} 4 1.000000 # Minimum time recover from being knocked down
{P044} 4 10.000000 # leaf-> time of bud (seconds)
{P045} 4 10.000000 # bud-> flower time (seconds)
{P046} 4 10.000000 # flower-> time of seed (seconds)
{P047} 4 10.000000 # seed-> time of leaf (seconds)
{P048} 4 0.600000 # Gravity factor for when flower Pikmin fall after being thrown
{P049} 4 0.100000 # Time until buried Pikmin sprout appears (seconds)
{P050} 4 5.000000 # Time until buried Pikmin sprout is pluckable (seconds)
{P051} 4 120.000000 # Time until growing to next seedling state(seconds)
{P052} 4 180.000000 # Time spent as a seedling in the flower state before regrowing(seconds)
{P053} 4 1.000000 # Time until seedling resprouts (seconds)
{P055} 4 6.000000 # Time to wrestle with death (Time until killed by fire/water/poison. Doesn't include drowning.)
{P056} 4 1.000000 # Probability of flower Piki to play as seed (Leftover Pikmin 1 data?)
{P057} 4 2.000000 # Time to explosion
{P058} 4 50.000000 # Bomb effect range
{P059} 4 200.000000 # Bomb damage amount Flood gate
{P075} 4 10.000000 # Bomb Damage Orima
{P076} 4 120.000000 # Bomb Damage Teki
{P077} 4 765.000000 # Bomb Damage Piki
{P060} 4 200.000000 # Sunset Survival range
{P061} 4 250.000000 # Column activation distance
{P062} 4 10 # drowning frame number
{P063} 4 10 # Number of drowning frames (variation)
{P064} 4 5.000000 # wall pushing up time
{P066} 4 300.000000 # BOMB search distance (More Leftover pikmin 1 data?)
{P067} 4 110.000000 # BOMB throw Min (ditto for this and most of the Other "BOMB" settings)
{P068} 4 160.000000 # BOMB throw Max
{P069} 4 1.500000 # BOMB placement escape time
{P070} 4 150.000000 # BOMB throwing speed
{P071} 4 300.000000 # BOMB Warning range
{P072} 4 0.650000 # Between BOMB, time
{P073} 4 50.000000 # BOMB set distance
{P000} 4 1.250000 # Scale of new color
{P001} 4 1.200000 # White Pikmin speed multiplier (speed settings for whites and purples)
{P002} 4 0.800000 # Purple Pikmin speed multiplier (ditto)
{P005} 4 0.600000 # Purple Pikmin carry speed multiplier (ditto)
{P006} 4 3.000000 # White Pikmin carry speed multiplier (ditto)
{P020} 4 0.500000 # Buds carry speed bonus
{P021} 4 1.000000 # Flower carry speed bonus
{P018} 4 0.400000 # Carrying MAX FACTOR
{P019} 4 0.220000 # Carrying MIN FACTOR (original comment likely a mistake)
{P007} 4 40.000000 # Doping duration (Ultra-Spicy spray duration)
{P008} 4 10.000000 # Doping Piki Attack (Ultra-Spicy spray attack increase)
{P009} 4 190.000000 # Doping Piki Speed (Ultra-Spicy spray speed increase)
{P016} 4 60.000000 # Jellyfish digestion time (Time a Pikmin is inside a Jellyfloat before it dies)
{P017} 4 60.000000 # Purple Pikmin slam area of impact radius
{P022} 4 20.000000 # Purple Pikmin slam damage
{_ Eof}
}
</source></div>
|}

[[Category:Pikmin 2]]

Main Page

2025-08-31T03:10:37Z

Iwillremembermypasswordthistime: add p1 screen list

{{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" | <span style="font-size: 150%;">Global info</span>
|-
| 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%;" | <span style="font-size: 150%;">''Pikmin''</span><br><span style="font-size: 90%;">(and ''New Play Control! Pikmin'')</span>
! width="20%;" | <span style="font-size: 150%;">''Pikmin 2''</span><br><span style="font-size: 90%;">(and ''New Play Control! Pikmin 2'')</span>
! width="20%;" | <span style="font-size: 150%;">''Pikmin 3''</span><br><span style="font-size: 90%;">(and ''Pikmin 3 Deluxe'')</span>
! width="20%;" | <span style="font-size: 150%;">''Hey! Pikmin''</span>
! width="20%;" | <span style="font-size: 150%;">''Pikmin 4''</span>
|-

! 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)]]
* [[Se.bms|Sound effects list]]
* [[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)
** [[BX file]] (Sound system archive)
** [[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)
* [[AAF file]] (Sound system archive)
* [[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)]]
* [[BFRES file|BFRES (file container, usually for 3D models and animations)]]
* [[BFLYT file|BFLYT (2D layout data)]]
* [[MSBT file (Pikmin 3)|MSBT (text string)]]
* [[MSBF file (Pikmin 3)|MSBF (message flow)]]
* [[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]]
* [[Pikmin 2 day time parameters|Day time 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" |
* [[pikibank.bx|Pikmin audio system]]
* [[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" |
* [[PSound.aaf|Audio system]]
* Pellet List
** [[Pikmin 2 otakara_config.txt|Treasure Config]]
** [[Pikmin 2 item_config.txt|Upgrade 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" |
* [[Screen file list (Pikmin)]]
| valign="top" |
* [[Screen file list (Pikmin 2)]]
| 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|Custom models]]
* [[How J3D model materials work]]
* [[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 Editing and Creation]]
* [[Cutscene Notes]]
* [[Creating Interactive BMS Files|Creating interactive area music]]
* [[Creating cave music|Creating interactive cave music]]
* [[Editing code with Decomp|Editing code with Decomp]]

| 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]]
* [[FinModelUtility]]
* [[GameCube File Tools]]
* [[pyblo2-gui]]
* [[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]]

Screen file list (Pikmin)

2025-08-31T01:31:05Z

Iwillremembermypasswordthistime: typo

Below is a list of all screens in ''Pikmin''. Most screens are usually divided into individual BLO files in the <code>screen</code> folder in <code>dataDir</code>.

In the GameCube and US/JP/EU Wii versions, BLO files also contain most of the game's text strings. In the Korea Wii and all Switch versions, text is instead stored in <code>pikmin12/(language)/message/pik12message.bmg</code>.

__TOC__

{| class="wikitable"
! Screen || BLO Files || Image
|-
| Main Gameplay HUD || <code>play_day.blo</code> <br> <code>play10.blo</code> || [[File:Pikmin1mainhud.png|350px]]
|-
| Onion menu || US GC, JP GC: <code>con01.blo</code> <br> PAL GC, US Wii, JP Wii, EU Wii, Switch version: <code>conmix.blo</code> || [[File:pikmin1onionmenu.png|350px]]
|-
| File select || See [[File Select (Pikmin 1) | File Select ]] page|| [[File:pikmin1fileselect.png|350px]]
|-
| High scores || <code>cha_hi.blo</code> || [[File:pikmin1highscores.png|350px]]
|-
| Challenge mode select || <code>cha_sel.blo</code> <br> <code>cha_rank.blo</code> <br> <code>cha_best.blo</code> <br> <code>cha_map.blo</code> || [[File:pikmin1challengeselect.png|350px]]
|-
| Day results || <code>account2.blo</code> || [[File:Pikmin1dayresults.png|350px]]
|}

File:Pikmin1dayresults.png

2025-08-31T01:30:33Z

Iwillremembermypasswordthistime:

Screen file list (Pikmin)

2025-08-31T01:30:26Z

Iwillremembermypasswordthistime: more screens

File:Pikmin1challengeselect.png

2025-08-31T01:18:59Z

Iwillremembermypasswordthistime:

Screen file list (Pikmin)

2025-08-31T01:15:28Z

Iwillremembermypasswordthistime: forgot korea uses brlyt

Screen file list (Pikmin)

2025-08-31T01:14:30Z

Iwillremembermypasswordthistime: add file select and high scores

Below is a list of all screens in ''Pikmin''. Most screens are usually divided into individual BLO files in the <code>screen</code> folder in <code>dataDir</code>.

In the GameCube and US/JP/EU Wii versions, BLO files also contain most of the game's text strings. In the Korea Wii and all Switch versions, text is instead stored in <code>pikmin12/(language)/message/pik12message.bmg</code>.

__TOC__

{| class="wikitable"
! Screen || BLO Files || Image
|-
| Main Gameplay HUD || <code>play_day.blo</code> <br> <code>play10.blo</code> || [[File:Pikmin1mainhud.png|350px]]
|-
| Onion menu || US GC, JP GC: <code>con01.blo</code> <br> PAL GC, all Wii & Switch versions: <code>conmix.blo</code> || [[File:pikmin1onionmenu.png|350px]]
|-
| File select || See [[File Select (Pikmin 1) | File Select ]] page|| [[File:pikmin1fileselect.png|350px]]
|-
| High scores || <code>cha_hi.blo</code> || [[File:pikmin1highscores.png|350px]]
|}

File:Pikmin1highscores.png

2025-08-31T01:11:38Z

Iwillremembermypasswordthistime:

File:Pikmin1fileselect.png

2025-08-31T01:05:11Z

Iwillremembermypasswordthistime:

Screen file list (Pikmin)

2025-08-31T01:04:12Z

Iwillremembermypasswordthistime: add onion menu picture

File:Pikmin1onionmenu.png

2025-08-31T01:03:42Z

Iwillremembermypasswordthistime:

Screen file list (Pikmin)

2025-08-31T01:03:04Z

Iwillremembermypasswordthistime: adding more

Pikmin 2 instructions

2025-08-17T20:20:14Z

Iwillremembermypasswordthistime: update jaimaker version

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|Elaborate.}}

It's recommended you refer to the file lists and other pages on the main page while editing.

==Tools and files==

Here are some prominent files that come up when modding.
.DOL: Segmented executable binary format 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. Usually named wScene in Pikmin 2.
.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.
.BCK: Keyframed animation data.

Here are some prominent tools:

[https://github.com/SuperHackio/WiiExplorer/releases/download/V1.5.0.5/WiiExplorer.V1.5.0.5.zip WiiExplorer]- Used for extracting and converting RARC archives. Can also compress archives to 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://github.com/XAYRGA/JAIMaker/releases/download/1.7.3/JAIMaker.1.7.3.-.Lightly.Salted.Almond.zip JAIMaker] - Used for creating custom sequenced music as BMS files. Also supports creating interactive overworld music. Cave music requires 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/2.0.0 GameCube File Tools] - Used for modification of many GameCube/early Wii era formats, notably BTI files.
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.

A page listing the game's internal filesystem is [https://pikmintkb.com/wiki/Pikmin_2_directory_tree here], useful for keeping track of where editable files are.

==Cave editing==

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

See [https://pikmintkb.com/wiki/Cave_generation_parameters this page] for cave generation specifics.

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

You can edit overworld generation with the Gen & Route Editor

Instructions on how to use the program are in its reademe as well as the page on this website.
See [https://pikmintkb.com/wiki/Pikmin_2_area_generator_file this page] for overworld generation specifics.

To change what sounds are made when a leader walks on ground, or to change where Pikmin seeds can sprout, use obj2grid to convert the grid.bin/mapcode.bin files (located in texts.szs for a given area or cave unit model) to obj, then import this obj into blender. Make a material on the mesh you want to edit, and name it according to this scheme:

0xXY

First Digit (Physical characteristics):

Pikmin seeds can root:
0 - full friction (friction is slipperyness)
1 - some friction
2 - no friction

Pikmin seeds die:
4 - full friction
5 - some friction
6 - no friction

Second Digit (Sound index):

0 - grass
1 - soil
2 - sand
3 - wood
4 - water
5- stone
6 - iron
7 - snow
8 - water (has water particle effects when used with 1 as the first digit)
9 - paper

export the model back to obj, use obj2grid to convert the obj to grid.bin/mapcode.bin, and import back into the game.

==Model replacement==
see this guide for now
https://pikmintkb.com/wiki/Custom_models

==Adding more treasures==

create a new szs in \user\Abe\Pellet\<region> with your bmd, as well as the carry.bck animation. make sure that the bmd and szs are named the same thing (ex. ahiru.bmd, ahiru.szs).
then go to otakara_config.txt in pelletlist_(language).szs and add a new entry for your custom treasure, and edit anything you need to. make sure the names refer to the correct things. At the top of the file, increment the number at the top (normally 188). then, open otakara_texts.szs and create a new folder with the same name as your szs containing an animmgr.txt and a collinfo.txt (you can copy these from another treasure).
This is all you need to do to get the treasure working in game, however the piklopedia requires a bit more work.
go to \user\Matoba\resulttex\us\arc.szs and again create a folder with the name of your custom treasure. this is where you will but an icon for your treasure.
the icon should be a 32 x 32 bti image named texture.bti.
finally, go to \message\mesRes_<language>.szs and extract pikmin2.bmg using the bmg tool in ⁠pikmin-tools. there, you will add an entry for your treasure's in game name (this does not have to be the same name as the one in the filesystem) and also a piklopedia entry for your treasure. You should be all set at that point.

==Menu and HUD editing ==

BLO files, which house most of the screen resources, can be edited with pyblo2-gui. Often, positions of a UI element may be controlled by a BCK element, which can be edited in the animation part of the program.
BRK and BTK animations may also be involved,which can be edited with bark_conv and btk-conv respectively. BPK files can be edited with j3d-animation-editor.

==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. Review [https://docs.google.com/document/d/1UNhdBL3tYAn9sHO8gdOVJIpaHVo9_bbCLz7OazkEgZA/edit this document] to see what instruments you can use for your song depending on what bms you're replacing (if you're not editing wScenes with the Sound Modding Toolkit, that is)

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, wScene editing + creation, 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]]

PSound.aaf

2025-08-17T08:09:22Z

Iwillremembermypasswordthistime: tweaks

<code>AudioRes/PSound.aaf</code> is an [[AAF File|AAF]] file which defines the game's sound system. It contains references to [[AST file|streamed]] and [[BMS file|sequenced]] music files as well as data for sound effects and instruments.<br>

==Overview==
This page describes the contents of PSound.aaf when converted with the [https://xayr.gay/tools/SoundModdingToolkit/ Pikmin 2 SoundModdingToolkit].

<h2>Instruments</h2>
''Found in the "AudioModding/IBNK(number)/include" folders, as "Inst_(number).json"'' </br>
Defines instruments used by sequenced music and sound effects.

<h3>IBNK0</h3>
''Defined by "AudioModding/IBNK0/ibnk.json".''<br>

Contains instrument data for sound effects brought over from Pikmin 1.

<h3>IBNK1</h3>
''Defined by "AudioModding/IBNK1/ibnk.json".''<br>

Contains instrument data for sound effects created by Takahiro Watanabe.

<h3>IBNK2</h3>
''Defined by AudioModding/IBNK2/ibnk.json.''<br>

Contains instrument data for sound effects created by Kazumi Totaka.

<h3>IBNK3</h3>
''Defined by "AudioModding/IBNK3/ibnk.json".''<br>

Contains instrument data for sound effects created by Mitsuhiro Hikino.

<h3>IBNK4</h3>
''Defined by "AudioModding/IBNK4/ibnk.json".''<br>

Contains instrument data for sequenced music created by Hajime Wakai.

<h3>IBNK5</h3>
''Defined by "AudioModding/IBNK5/ibnk.json".''<br>

Contains instrument data for sequenced music created by Kazumi Totaka.

<h3>IBNK6 (Wii only)</h3>
''Not currently extracted by the Toolkit, though can be with some minor tweaks to the initialization script.''<br>

Contains instrument data for Wii Home Menu sound effects. (advised to not be touched)

<h2>Wave System</h2>
''Found in the "AudioModding/0/" or "AudioModding/WS_MainWSYS" folder'' </br>
Defines sample data used by instruments.<br>
GameCube Pikmin 2 has one main WaveSystem used for all music and sound effects. Wii Pikmin 2 has an additional smaller one for the Wii Home Menu.<br>

manifest.json controls how many wScene (wave scene, control which samples are loaded at a given time) definitions are in the AAF.<br>
wavetable.json controls information about the specific audio waves, such as sample rate, looping, and what type of sound it is (e.g. ADPCM4 or PCM16)<br>
The scenes subfolder contains wScene definition jsons.<br>

<h2>Sound Table</h2>
''Contains allocations for all sounds, whether streamed music, sequenced music or sound effects.''<br>
In the ''AudioModding/SoundTable/includes'' folder, json definitions can be found for each category of sound.<br>
There are six (seven in Wii) sound effects categories (1-6/7), one sequenced music category (10), and one streamed music category (11).<br>
In the AAF, the categories are arranged 10, 11, 7 (Wii only), 6, 5, 4, 3, 2, 1.<br>

Further info about categories 1-6 can be found on the [[Se.bms|sound effects list page]].

<h3>Category 10</h3>
Category 10 contains entries for each sequenced music song in the game.<br>
This part of the AAF is mostly overwritten by <code>user/Totaka/BgmList.txt</code>, which lists each BMS file's filename, and the volume of the music track. The game will usually refer to BMS files directly by filename instead of sound ID.

<h3>Category 11</h3>
Category 11 contains entries for each streamed music song in the game.<br>
This part of the AAF is augmented by <code>user/Totaka/StreamList.txt</code>, which lists each AST file's internal name (defined in AudioRes/PSound.asn), the ID of the song (defined here in category 11) and the volume of the music track. The game loads AST files through the sound ID determined here.

<h2>Stream Table</h2>

This part of the AAF defines the file name of each AST file in the game.

PSound.aaf

2025-08-17T08:02:09Z

Iwillremembermypasswordthistime: add rudimentary info on aaf

<code>AudioRes/PSound.aaf</code> is an '[[AAF File|AAF]] file which defines the game's sound system. It contains references to [[AST file|streamed]] and [[BMS file|sequenced]] music files as well as data for sound effects and instruments.<br>

==Overview==
This page describes the contents of PSound.aaf when converted with the [https://xayr.gay/tools/SoundModdingToolkit/ Pikmin 2 SoundModdingToolkit].

<h2>Instruments</h2>
Found in the ''AudioModding/IBNK(number)/inlcude'' folders, as ''Inst_(number).json'' </br>
Defines instruments used by sequenced music and sound effects.

<h3>IBNK0</h3>
Defined by AudioModding/IBNK0/ibnk.json.<br>

Contains instrument data for sound effects brought over from Pikmin 1.

<h3>IBNK1</h3>
Defined by AudioModding/IBNK1/ibnk.json.<br>

Contains instrument data for sound effects created by Takahiro Watanabe.

<h3>IBNK2</h3>
Defined by AudioModding/IBNK2/ibnk.json.<br>

Contains instrument data for sound effects created by Kazumi Totaka.

<h3>IBNK3</h3>
Defined by AudioModding/IBNK3/ibnk.json.<br>

Contains instrument data for sound effects created by Mitsuhiro Hikino.

<h3>IBNK4</h3>
Defined by AudioModding/IBNK4/ibnk.json.<br>

Contains instrument data for sequenced music created by Hajime Wakai.

<h3>IBNK5</h3>
Defined by AudioModding/IBNK5/ibnk.json.<br>

Contains instrument data for sequenced music created by Kazumi Totaka.

<h3>IBNK6 (Wii only)</h3>
Not currently extracted by the Toolkit, though can be with some minor tweaks.<br>

Contains instrument data for Wii Home Menu sound effects. (advised to not be touched)

<h2>Wave System</h2>
Found in the ''AudioModding/0/'' or ''AudioModding/WS_MainWSYS'' folder </br>
Defines sample data used by instruments.<br>
GameCube Pikmin 2 has one main WaveSystem used for all music and sound effects. Wii Pikmin 2 has an additional smaller one for the Wii Home Menu.

manifest.json controls how many wScene (wave scene, control which samples are loaded at a given time) definitions are in the AAF.<br>
wavetable.json controls information about the specific audio waves, such as sample rate, looping, and what type of sound it is (e.g. ADPCM4 or PCM16)<br>
The scenes subfolder contains wScene definition jsons.<br>

<h2>Sound Table</h2>
Contains allocations for all sounds, whether streamed music, sequenced music or sound effects.<br>
In the ''AudioModding/SoundTable/includes'' folder, json definitions can be found for each category of sound.<br>
There are six (seven in Wii) sound effects categories (1-6/7), one sequenced music category (10), and one streamed music category (11).<br>
In the AAF, the categories are arranged 10, 11, 7 (Wii only), 6, 5, 4, 3, 2, 1.

Further info about categories 1-6 can be found on the [[Se.bms|sound effects list page]].

<h3>Category 10</h3>
Category 10 contains entries for each sequenced music song in the game.<br>
This part of the AAF is mostly overwritten by <code>user/Totaka/BgmList.txt</code> which lists each BMS file's filename, and the volume of the music track.

<h3>Category 11</h3>
Category 11 contains entries for each streamed music song in the game.<br>
This part of the AAF is mostly overwritten by <code>user/Totaka/StreamList.txt</code> which lists each AST file's internal name (defined in AudioRes/PSound.asn), the ID of the song (defined here in category 11) and the volume of the music track.

<h2>Stream Table</h2>

This part of the AAF defines the file name of each AST file in the game.

Main Page

2025-08-17T07:06:54Z

Iwillremembermypasswordthistime: fix swap

{{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" | <span style="font-size: 150%;">Global info</span>
|-
| 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%;" | <span style="font-size: 150%;">''Pikmin''</span><br><span style="font-size: 90%;">(and ''New Play Control! Pikmin'')</span>
! width="20%;" | <span style="font-size: 150%;">''Pikmin 2''</span><br><span style="font-size: 90%;">(and ''New Play Control! Pikmin 2'')</span>
! width="20%;" | <span style="font-size: 150%;">''Pikmin 3''</span><br><span style="font-size: 90%;">(and ''Pikmin 3 Deluxe'')</span>
! width="20%;" | <span style="font-size: 150%;">''Hey! Pikmin''</span>
! width="20%;" | <span style="font-size: 150%;">''Pikmin 4''</span>
|-

! 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)]]
* [[Se.bms|Sound effects list]]
* [[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)
** [[BX file]] (Sound system archive)
** [[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)
* [[AAF file]] (Sound system archive)
* [[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)]]
* [[BFRES file|BFRES (file container, usually for 3D models and animations)]]
* [[BFLYT file|BFLYT (2D layout data)]]
* [[MSBT file (Pikmin 3)|MSBT (text string)]]
* [[MSBF file (Pikmin 3)|MSBF (message flow)]]
* [[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]]
* [[Pikmin 2 day time parameters|Day time 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" |
* [[pikibank.bx|Pikmin audio system]]
* [[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" |
* [[PSound.aaf|Audio system]]
* Pellet List
** [[Pikmin 2 otakara_config.txt|Treasure Config]]
** [[Pikmin 2 item_config.txt|Upgrade 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" |
* [[Screen file list (Pikmin 2)]]
| 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 Editing and Creation]]
* [[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]]
* [[FinModelUtility]]
* [[GameCube File Tools]]
* [[pyblo2-gui]]
* [[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

2025-08-17T07:05:32Z

Iwillremembermypasswordthistime: additions

{{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" | <span style="font-size: 150%;">Global info</span>
|-
| 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%;" | <span style="font-size: 150%;">''Pikmin''</span><br><span style="font-size: 90%;">(and ''New Play Control! Pikmin'')</span>
! width="20%;" | <span style="font-size: 150%;">''Pikmin 2''</span><br><span style="font-size: 90%;">(and ''New Play Control! Pikmin 2'')</span>
! width="20%;" | <span style="font-size: 150%;">''Pikmin 3''</span><br><span style="font-size: 90%;">(and ''Pikmin 3 Deluxe'')</span>
! width="20%;" | <span style="font-size: 150%;">''Hey! Pikmin''</span>
! width="20%;" | <span style="font-size: 150%;">''Pikmin 4''</span>
|-

! 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)]]
* [[Se.bms|Sound effects list]]
* [[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)
** [[BX file]] (Sound system archive)
** [[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)
* [[AAF file]] (Sound system archive)
* [[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)]]
* [[BFRES file|BFRES (file container, usually for 3D models and animations)]]
* [[BFLYT file|BFLYT (2D layout data)]]
* [[MSBT file (Pikmin 3)|MSBT (text string)]]
* [[MSBF file (Pikmin 3)|MSBF (message flow)]]
* [[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]]
* [[Pikmin 2 day time parameters|Day time 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" |
* [[Pikmin audio system|pikibank.bx]]
* [[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" |
* [[PSound.aaf|Audio system]]
* Pellet List
** [[Pikmin 2 otakara_config.txt|Treasure Config]]
** [[Pikmin 2 item_config.txt|Upgrade 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" |
* [[Screen file list (Pikmin 2)]]
| 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 Editing and Creation]]
* [[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]]
* [[FinModelUtility]]
* [[GameCube File Tools]]
* [[pyblo2-gui]]
* [[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]]

Mail Table

2025-08-17T06:41:58Z

Iwillremembermypasswordthistime: initial mail table page

<code>user/Koono/mail_table.bin</code> is the config file used for space mail entries at the end of day screen.<br>
it can be converted using [[https://github.com/pish-pish/MailTableConverter MailTableConverter]].

RARC file

2025-08-17T06:35:29Z

Iwillremembermypasswordthistime: grab info from luma's workshop

The RARC file format is an archive format commonly found in first party Nintendo GameCube games. Many files are stored in these archive files in a similar way to ZIP and 7Z files.

In Pikmin 2's file structure, ARC files are nowhere near as common as the SZS file, which is a version of the format that's compressed via Yaz0 compression.

Extracting and repacking these archives is done by using WiiExplorer. WiiExplorer also allows compressing archives with Yaz0 compression, though at the time of writing, it does not take into account a quirk with Pikmin 2 where Yaz0 compressed archives have to be padded to 0x20 bytes. Use [https://pikmintkb.com/wiki/GameCube_File_Tools GameCube File Tools] for Yaz0 compression instead.

= Format Specifications =
Below you'll find helpful tables on how the file is structured
== Header ==
Each RARC starts with a ''header''
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || String || "RARC" in ASCII
|-
| 0x04 || UInt32 || Size of the entire file
|-
| 0x08 || UInt32 || Data Header Offset (Always 0x20)
|-
| 0x0C || UInt32 || Offset to the File Data section minus 0x20
|-
| 0x10 || UInt32 || Length of the File Data section
|-
| 0x14 || UInt32 || Size of all the MRAM Files in the File Data section
|-
| 0x18 || UInt32 || Size of all the ARAM Files in the File Data section
|-
| 0x1C || UInt32 || Size of all the DVD Files in the File Data section
|-
|}
== Data Header ==
This section has information on the entire archive
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt32 || The number of Directory Nodes
|-
| 0x04 || UInt32 || Offset to the Directory Nodes section minus 0x20 (always 0x20)
|-
| 0x08 || UInt32 || The number of File Nodes
|-
| 0x0C || UInt32 || Offset to the File Nodes section minus 0x20
|-
| 0x10 || UInt32 || Size of the String Table
|-
| 0x14 || UInt32 || String Table offset minus 0x20
|-
| 0x18 || UInt16 || The next available File Index
|-
| 0x1A || bool || Keeps the File ID's Synced (Always 0x01, or TRUE in SMG)
|-
| 0x1B || UInt8[5] || Padding, All 0x00's
|-
|}
== Directory Node section ==
This section is a list of information for each folder (or, subdirectory) in the archive.<br/>
Each list entry looks like this:
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || String || The first 4 characters in the Directory's name in all caps.<br/>Example: "RootFolder" = "ROOT", and "Tmp" = "TMP " (Names less than 4 characters are padded to 4 characters with spaces)
|-
| 0x04 || UInt32 || Offset to the Directory's name in the String Table
|-
| 0x08 || UInt16 || Hash of the Directory's name
|-
| 0x0A || UInt16 || The number of File Nodes in this directory
|-
| 0x0C || UInt32 || Offset to the first File Node in the File Nodes section
|-
|}
== File Node section ==
This section is a list of information for each file in the archive. It also contains entries for directories so we can know which directory belongs where.<br/>
Each list entry looks like this:
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt16 || Node Index (0xFFFF if this entry represents a subdirectory)
|-
| 0x02 || UInt16 || Hash of the Node's name
|-
| 0x04 || UInt8 Bitfield || Defines certain Node Attributes. See the Node Attributes table below.
|-
| 0x05 || UInt8[1] || Padding. 0x00
|-
| 0x06 || UInt16 || Offset to the Node's name in the String Table
|-
| 0x08 || UInt32 || If this node represents a file: Offset to the File's Data in the File Data section.<br/>If this node represents a directory: Directory Node section index to use
|-
| 0x0C || UInt32 || If this node represents a file: Size of the File's Data.<br/>If this node represents a directory: The size of the Directory Node (always 0x10)
|-
|}
=== Node Attributes ===
{| class="wikitable"
! Mask !! Name !! Description
|-
| 0x01 || FILE || This node is a File
|-
| 0x02 || DIRECTORY || This node is a Directory
|-
| 0x04 || COMPRESSED || This node's file is compressed
|-
| 0x10 || PRELOAD_TO_MRAM || Set the file to be loaded into Main RAM
|-
| 0x20 || PRELOAD_TO_ARAM || Set the file to be loaded into Auxiliary RAM (GameCube only)
|-
| 0x40 || LOAD_FROM_DVD || Set the file to be loaded right off the DVD when needed
|-
| 0x80 || YAZ0_COMPRESSED || This node's file is specifically YAZ0 compressed. Enable the COMPRESSED flag as well when using this
|-
|}

Among the File Nodes are nodes for a ".." and "." directory. The "." entry points to the current directory, and the ".." directory points to the parent directory (or 0xFFFFFFFF if the current directory is the topmost directory).

== String Table ==
This section is composed of NULL-terminated ASCII strings. The above information references these strings.

== File Data section ==
This section is a chunk of all the data that files in the archive contain. Files are sorted in a specific order, and are padded to the nearest 32 byte boundary.<br/>The sorting order is MRAM Files then ARAM Files then DVD Files.

BARC file

2025-06-26T18:00:29Z

Iwillremembermypasswordthistime: rewrite

{{stub}}
'''BARC files''' are a file format used in some games using the JAudio sound engine, such as Luigi's Mansion and Super Mario Sunshine. These files contain all of the music sequences used in the game.

In Pikmin, the BARC file is named <code>pikiseq.arc</code>, and is located in <code>dataDir/SndData/Seqs.</code> The header of the BARC, <code>pikiseq.hed</code> is embedded in the game's DOL, though if it is not found there, it will load the file from the disc.

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

Cutscene Editing and Creation

2025-06-06T06:02:00Z

Iwillremembermypasswordthistime: minor tweaks

This page will run through editing and creating your own cutscenes in Pikmin 2. <br>
Cutscenes use the JStudio library, which was used in Wind Waker, Twilight Princess, Pikmin 2, and Skyward Sword.<br>
In Pikmin 2, cutscenes are contained in <code>demo.szs</code> files in <code>user/Mukki/movie</code>.<br>
Inside these szs files are a few assets, most notably the JStudio Binary (STB) file. This file controls initialization of cutscene data, as well as camera instructions.<br>
We can use a program called [https://drive.google.com/file/d/1JNqFF1IuJgdwzNA3XvVUEapyCwc2xfvP STB2JSON] to convert this to a more readable format.<br>

Note when extracting cutscene archives, you must use a program like WiiExplorer that can preserve the file indexes. This is because stb files load assets based in index, not by filename.<br>

<h1>STB Basics</h1>

STB files are separated into different "blocks" that can represent different "objects". The available blocks in the format are:

- JFVB (function value block)<br>
- JCMR (camera)<br>
- JABL (ambient light)<br>
- JACT (actor)<br>
- JSND (sound)<br>
- JLIT (light)<br>
- JCNT (control)<br>
- JMSG (message)<br>
- JFOG (fog)<br>
- JPTC (particle)<br>

Pikmin 2 only uses JFVB, JCMR, JCNT, JACT, JMSG, and JSND (which are the blocks that are going to be covered here), though the other blocks are theoretically supported. (note STB2JSON only supports the blocks vanilla uses) Particles are instead actors with a special identifier (an @ symbol in front of the name of the actor)

An object contains a list of "commands":

* "VAR" to bind a value/function to a variable
* "SET" to directly affect a properties of the bound object
* "WAIT" to halt the execution of the object for a certain amount of frames
* "SYNC" to halt the execution of the object until an event, external to the STB, is fired
* "OFLG", "XFLG" and "AFLG" to OR/XOR/AND the stb flags with a value

Each object has a set of "variables", which are bound to a properties of the object. A value/function can be bound to a variable using the "VAR" command:

"VAR (VarName) (Value/function) (Data)",

The value/function types are:

Void, to write a 0 to the variable<br>
Immediate, to write a direct value to the variable (specified in (Data))<br>
Time, to write a direct value, that is multiplied by the number of frames since the last "WAIT" command multiplied by 0.03333333, to the variable (specified in (Data))<br>
Index, to attach a JFVB function to the variable (the function index is specified in (Data)).<br>

A variable can affect more than one value of the bound object, in this case, the (Data) field
will have more than 1 value.<br>
After the delay of a "WAIT" command has passed, ALL value/function will be unbound from the
variables.

An object's name is defined by the "Type" field.

The JFVB block is the only one that does not represent objects. Instead, it holds "functions" all that represent data and how it evolves over time. There are two main types of functions used: "Constant", which contains a value that never changes, and "Hermite", which contains a value that changes following Hermite interpolation.
This is where values such as animation translation data and camera coordinates are stored.

A group of values typically looks like this:
<pre>
{
"Func": "Hermite",
"Range": "0.0 12.966666",
"Data": [
[
"0.0",
"70.229546",
"0.0",
[
"12.966666",
"188.07487",
"0.0",
],
]
},</pre>

The range is typically the start and end frames of the movement, if the value is not a constant value. To convert between the time values in range and frames, divide the frame number by 0.03333333.<br>
in this example, 12.966666 becomes roughly frame 389. To convert frames to time, multiply by 0.03333333.

Each subgroup of values has three floats. The first one is the time, the second is the value of whatever you're putting (camera coordinates, animation translation data, etc), and the third is the tangent value for the hermite interpolation. Setting tangent values to 0.0 will result in a smooth ease.

<h1>Camera</h1>

Note when getting camera coordinates, the position coordinates and target coordinates will be relative to the origin of the cutscene's location (wherever it is activated). The origin of a cutscene is specified in <code>user/Mukki/movie/demos.txt</code>, and that value will need to be accounted for when getting coordinate values. <br>
Position flags are also important to note too.<br>

A position flag of 2 will use the origin and camera angle specified in <code>demos.txt</code> (both value are confusingly named origin in the file, but the origin is the one with three floats and the angle is the one with one float)<br>
A position flag of 4 or 8 will use the origin and camera angle specified in the code that plays the specific cutscene. (8 specifically will also try to get the best camera angle for the cutscene when played)<br>
A position flag of 16 will do the same as 4 & 8, in addition to taking into account the sound position of certain objects in the cutscene (specified in code)<br>

For this example, we will be using a cutscene <code>(x01_gamestart)</code> with an origin of <code>0.0, 0.0, 0.0</code>, and we will use the pikmin 2 gen editor to get coordinates, where values will be relative to <code>0.0, 0.0, 0.0</code> of the map's origin (which will serve as our cutscene origin, as the position flag is set to 2).
Let's start making our stb. It's a good idea to start by getting a vanilla stb, and converting it to json, then editing our own values in.<br>
First, we're just doing camera, so delete everything aside from the JFVB and JCMR blocks.

To setup our camera block, input this information:

<pre>"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},</pre>

Setting the Type to "camera" will set the camera.<br>

Camera variables are:<br>

* ProjFovy - the field of view (FOV) of the camera. (float)
* ViewRoll - the rotation of the camera. (float)
* ViewPos - the XYZ position of the camera in the world. (float)
* TargPos - the XYZ position of where the camera is looking in the world. (float)
* Distance - the culling distance of the camera. It is usually set to <code>1.0 12800.0</code> (near distance, far distance) (float)

The indexes here correspond to values in the function value block. For instance, TargPos index 7 will have the Z coordinate of where the camera is looking take the values from the eighth group in the JFVB block.<br>
The index counts from 0.

Let's start setting some values. Our first value (ProjFovy) will be the FOV of our camera. We want to keep it a constant value, so well have our first FVB group look like this:
<pre>
{ (this is the bracket for the start of our JSON)
"JFVB": { (this is the bracket for the start of the JFVB block)
"Values": [ (this is the bracket for the start of all data values in the block)
{
"Func": "Constant",
"Data": "45.0",
},</pre>

Our next group will be rotation values. As before, we want to keep this constant.
<pre>
{
"Func": "Constant",
"Data": "0.0",
},</pre>

Our JSON should now look like this:
<pre>
{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},

}</pre>

Now it's time to get position coordinates from the gen editor. Open up the files for the valley of Repose, as that is the location of where our cutscene is.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage1.png
</gallery>
Place a reference object for the first set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage2.png
</gallery>
Copy the XYZ coordinates of the object into the JSON. They should be in the third (X), fourth (Y), and fifth (Z) set of values as Hermite functions. <br>
The first time value should be 0.0, for the start of the cutscene. Make sure the range is from frames 0 to 565 (converted to time).
<pre>
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
]
},</pre>

Place a reference object for the second set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage3.png
</gallery>
Copy the XYZ coordinates of the second object into the JSON as the second set in the value groups.
The time value should be 18.83333145 (frame 565), for the end of the cutscene.
<pre>{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},</pre>
Now for the target coordinates. It helps to move your position in the gen editor to one of your position reference objects, to get a betteer view of where you want your camera to look.<br>
Place a reference object for your target coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage4.png
</gallery>
We'll use a Constant function for the target, since we currently do not want where the camera is looking to change.
Copy the XYZ coordinates of the object into the JSON. They should be in the sixth (X), seventh (Y), and eighth (Z) set of values.<br>

<pre>{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
](this is the bracket for the end of all data values in the block)
},(this is the bracket for the end of the JFVB block)</pre>

This is what your JSON should look like now:

<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
}</pre>

Now you can save your JSON, use STB2JSON to convert it to STB, then repack the cutscene archive.
If everything was done correctly, it should look like this ingame:
<gallery mode="packed-hover" widths=400px heights=400px>
File:cutscene1.gif
</gallery>

<h1>Actors (and particles)</h1>

Actors are the most complicated part of cutscenes, so we'll need to break a few things down. <br>

There are four main types of actors:

Game Actors, which are certain creatures in the game world (like navis and onions). These are denoted with a <code>*</code> symbol in front of the actor's name. <br>
Special Actors, which are actors that can activate certain commands. These are denoted with a <code>+</code> symbol in front of the actor's name. <br>
Particle Actors, which are particles. These are denoted with a <code>@</code> symbol in front of the actor's name. <br>
Actors, which are regular models placed in a cutscene. These are denoted with a <code>p</code> symbol in front of the actor's name, though this doesn't seem to be required. <br>

Sound effects are not part of the JACT block, but behave similarly to actors. These are denoted with a <code>#</code> symbol in front of the actor's name.

<h3>Game Actors</h3>

For Game Actors, each one has an identifier:

* <code>"theOrima"</code> is Olimar.
* <code>"theLouie"</code> is Louie/President.
* <code>"orimaAlive_1"</code> is the first alive leader.
* <code>"orimaAlive_2"</code> is the second alive leader.
* <code>"orimaDead_1"</code> is the first dead leader.
* <code>"orimaDead_2"</code> is the second dead leader.
* <code>"onyon_R"</code> is the Red Onion.
* <code>"onyon_Y"</code> is the Yellow Onion.
* <code>"onyon_B"</code> is the Blue Onion.
* <code>"ufo"</code> is the Hocotate Ship.
* <code>"pod"</code> is the Research Pod.
* <code>"pikmin"</code> is the target of the cutscene, if that target is a Pikmin.
* <code>"orima"</code> or "player" is the current active player.
* <code>"target</code>" is the target of the cutscene.

Game Actor variables are:

* Translation - the XYZ actor position offset from the movie position. (float)
* Rotation - the XYZ rotation of the actor relative to the actor's default orientation. Only the Y value seems to be used (float)

Game Actor properties are:

* AnimData
* Anim
* MovieTranslation

AnimData sets the index of the BCK data in the cutscene archive that will be applied to the creature it's set to affect. (int)
Anim sets which animation will be used. Setting Anim to "BCK" will use the BCK, while setting it to "None" will use the creature's base animation archive. (string)

Here's an example from the unused red onion boot cutscene <code>(g02_boot_onyonR)</code>:
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"SET MovieTranslation None",
"SET Anim None",
"SET AnimData 4",

</pre>

Here, Anim is set to None, so the animation will instead come from the onion's animations, and AnimData being set to 4 (counting from 0) will have the onion perform the fifth animation in the onion's <code>animmgr.txt</code>, which is <code>bootup.bck</code>.<br>

MovieTranslation defines how translation will be applied to the actor (string):

* "None" wont do anything,
* "Direct" will directly copy the translation to the actor position,
* "MinY" will directly copy the X and Z translations to the actor position, but set the Y position to the map's minimum Y,
* "FaceDir" will directly copy the translation to the actor position and copy the Y value of the Rotation variable to the direction the actor is facing,
* "MoviePos" will copy the movie position to the actor position.

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*theLouie",
"Commands": [
"VAR Translation Index 16 17 18",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 3",
"WAIT 70",
"VAR Translation Index 19 20 21",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 4",
"WAIT 350",
]
},</pre>
Here, our actor is <code>*theLouie</code> (Louie), the first set of translation (in this case, movement of Louie's model) coordinates come from the value groups at indexes 16, 17, 18 (counting from 0) in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fourth (0, 1, 2, 3) file in the archive as the animation.
<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage1.png
</gallery>
After waiting 70 frames (and after the textbox is cleared) the second set of translation coordinates come from the value groups at indexes 19, 20, 21 in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fifth (0, 1, 2, 3, 4) file in the archive as the animation.<br>

Translation coordinates can be obtained the same way as obtaining camera position coordinates. <br>

Onions (including the ship and pod), navis, underground cave holes, and geysers also have their own special properties that serve as commands that can be set. <br>

(note: the format for these identifiers is hex value/JSON name)<br>

Onions<br>

* 0x64/CreateHead1 - create sprout
* 0x65/Spot - starts onion/ship/pod spot effect
* 0x66/SpotState - stops onion/ship/pod spot effect
* 0x67/StartPropera - start ship propeller animation
* 0x68/StopPropera - stop ship propeller animation
* 0x69/CreateHead2 - create sprout

Navi <br>

* 0x64/EnterPikis - make Pikmin go into the onion/ship
* 0x66/HoleInPikis - make Pikmin go into a cave hole
* 0x67/FountainPikis - make Pikmin jump onto a geyser
* 0x68/DelShadow - hide leader shadow
* 0x69/DelParticles - hide leader particles
* 0x6a/AddParticles - show leader particles
* 0x6b/AddShadow - show leader shadow

Hole<br>

* 0x64 - make hole appear

Geyser

* 0x64 - make geyser appear

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"WAIT 105",
"SET CreateHead2",
"WAIT 315",
]
},</pre>

<h3>Particle Actors</h3>

Particle Actors are particles, getting their data from the <code>efx.jpc</code> included in the cutscene archive.

Particle actors have two properties:

* Parc - the particle ID (Short) and the particle list index (Byte) in the JPC.
* Targ - the object on which the particle will appear. If a second string is specified, the particle will appear on the object's model joint specified by the second string

Example:

<pre>"JACT": {
"Type": "@boot_gr_b",
"Commands": [
"SET Parc 5 5",
"SET Targ *onyon_R",
"WAIT 390",
]
},
"JACT": {
"Type": "@boot_gr_o",
"Commands": [
"SET Parc 6 5",
"SET Targ *onyon_R body_1",
"WAIT 390",
]
},</pre>

Particles have three variables:<br>

* Translation - XYZ position offset from the position of the object it is attached to, or the cutscene position if not attached to an object.(float)
* Rotation - XYZ rotation relative to the particle's default orientation(float)
* Scaling - XYZ size relative to the particle's default size(float)

If "ground" is the second string, the particle will uses the object position and ignore the object matrix.

<h3>Special Actors</h3>

Special Actors are actors that can affect parts of the game and execute special commands. They are usually context sensitive.<br>

The properties (commands) are:<br>

* 0x00/LeaveCave - abandon treasures and pikmin when giving up
* 0x01/DayEnd - create day end enemies, spawn left behind Pikmin
* 0x02/FallPikiSound - start falling Pikmin sound effects in cave entry
* 0x03/ForceEnterPiki - force Pikmin into the Onion on day 1
* 0x65/StartDemoCamera - start "demo" camera type (using the regular game camera instead of the cutscene camera)
* 0x66/EndDemoCamera - go back to normal player camera
* 0xC9/OpenKentei - open treasure collection UI (res_kantei)
* 0xCB/OpenKentei - open special item collection UI (res_special_item)
* 0x12D/FadeOut - fade the screen
* 0x12E/FadeIn - unfade the screen

Example:
<pre>"JACT": {
"Type": "+MovieCommand",
"Commands": [
"SET FallPikiSound",
"WAIT 219",
]
},</pre>

When the StartDemoCamera command is used, the cutscene will use the game's camera rather than the cutscene camera. This is mainly seen in <code>s03_orimadown</code>.

<h3>Actors</h3>

Actors are regular models that can appear in a cutscene.

Actor properties are:

* BCKIdx - sets the index of the BCK data in the cutscene archive that will be applied to the actor it's set to affect. (int)
* BMDIdx - sets the index of the BMD model the actor will use. (int)

Actor variables are

* Translation - the XYZ actor position offset from the movie position. (float)
* Scaling - the XYZ actor size relative to its default model size. (float)
* Rotation - the XYZ actor rotation relative to its default orientation. (float)<br>

Now that we've absorbed all that, let's add some actors to our cutscene.<br>

We're going to add Olimar, and have him play the down animation from <code>s03_orimadown</code>. We'll keep him stationary.

<pre>"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},</pre>

Note: because we don't have any translation going on here, olimar will be spawned where he would be spawned in regular gameplay.

<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage2.png
</gallery>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Actortutorialimage3.png
</gallery>

<h1>Sounds and messages</h1>

Message blocks are usually paired with a control block, presumably to halt things until the text box is done.<br>

<pre>"JMSG": {
"Type": "メッセージ",
"Commands": [
"WAIT 88",
"SET Code 894 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "コントロール",
"Commands": [
"WAIT 89",
"SYNC 1",
"WAIT 1",
]
},</pre>
The Type for messages is always "メッセージ" ("message"), and the Type for control is always "コントロール" ("control"). If there is more than one message/control in a cutscene, a number will follow the text (e.g. "メッセージ２" for the second message). Note that these aren't required, and currently, replacing the japanese text with english is needed for the rebuilding to not make a malformed STB.
Note the Code being set for the message block. The first three digits (short) are the message index (in decimal) in the [[BMG_file|BMG]]. The last digit (short) is the sub index of the message.

Sounds have two major components: Music, which is handled outside the STB, and sound effects, which for the most part are handled inside the STB.<br>

It's still worth mentioning some things about music:<br>

Which AST that is associated with which cutscene is controlled by <code>PSM::Demo::initiate</code> (in utilityU/PSMainSide_Demo.cpp) in the game's code. The function checks for a cutscene's name, then associates a stream file ID with it.

In vanilla, two cutscenes (<code>x20_blackman</code> and <code>x03_find_red_onyon</code>) are coded not to start with music initially. For the latter cutscene, audio is coded to start after the first text box has been closed.

Now about the other part of cutscene audio: Sound effects.<br>
This is what a typical sound block looks like:
<pre>"JSND": {
"Type": "#orimaAlive_2_1",
"Commands": [
"WAIT 335",
"SET Parent *orimaAlive_2",
"SET ParentNode happajnt3",
"SET ParentEnable True",
"SET Located True",
"SET ID 2161",
"SET BeginFadeIn 0.0",
"WAIT 12",
]
},</pre>

As stated earlier, a <code>#</code> in front of the name of the actor denotes a sound. <br>

Sound's properties are:

* Parent - binds the sound to an actor (in this case, the second alive player, or Louie) (string)
* ParentNode - further binds the sound to a specific joint on the model of the actor (string)
* ParentEnable - sets this binding to true. (boolean)
* Located - tells the sound to follow a position, whether from an attached creature or a direct position variable. (boolean)
* ID - the sound effect ID, in decimal. See [https://pikmintkb.com/wiki/Se.bms this page] for IDs. (int)
* Begin - starts the sound.
* BeginFadeIn - tells the sound to fade in when started, with the time it takes to fade in determined by the float after it.
* End - stops the sound.
* EndFadeOut - tells the sound to fade out when started, with the time it takes to fade out determined by the float after it.

Sound's variables are:

* Volume (float)
* Pan (float)
* Pitch (float)
* TempoProportion (float) - speed
* Fxmix (float) - reverb/echo
* Position (float) - XYZ sound position offset from the movie position

Let's add a sound effect and a text box to our cutscene.<br>

Text box first, we'll use message index 915 (in the BMG, this will show as hex, so it's actually 0x393) and have it appear at the end of the cutscene.

<pre>"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},</pre>

Due to a seemingly hardware dependent bug, the stb created by STB2JSON may have the "control block" represented as <code>0xEFBFBDEFBFBDEFBFBDEFBFBD</code> instead of <code>0xFFFFFFFF</code>, which is the correct one. If this happens, open your stb in a hex editor and change the offending bytes, making sure to delete the extra bytes.
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage1.png
</gallery>
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage2.png
</gallery>
Now let's test in game. <br>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Messagetutorialimage3.png
</gallery>

Finally, let's add a sound. Let's play <code>PSSE_SY_WMAP_MONEY_UP</code> (one of the ka-ching sounds)
We're not going to tie it to any actor, just have it play on its own.

<pre>"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},</pre>

Our whole JSON should now look like this:
<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},
"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},
"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},
}
</pre>
Convert your JSON to STB, remember to fix the control block if needed, repack your archive with WiiExplorer (make sure the file IDs are correct!), and play the cutscene in game.<br>

Congratulations, you have now made a full cutscene! Feel free to experiment with editing vanilla cutscenes, or making more of your own.

Cutscene Editing and Creation

2025-06-04T17:30:24Z

Iwillremembermypasswordthistime: correction

This page will run through editing and creating your own cutscenes in Pikmin 2. <br>
Cutscenes use the JStudio library, which was used in Wind Waker, Twilight Princess, Pikmin 2, and Skyward Sword.<br>
In Pikmin 2, cutscenes are contained in <code>demo.szs</code> files in <code>user/Mukki/movie</code>.<br>
Inside these szs files are a few assets, most notably the JStudio Binary (STB) file. This file controls initialization of cutscene data, as well as camera instructions.<br>
We can use a program called [https://drive.google.com/file/d/1JNqFF1IuJgdwzNA3XvVUEapyCwc2xfvP STB2JSON] to convert this to a more readable format.<br>

Note when extracting cutscene archives, you must use a program like WiiExplorer that can preserve the file indexes. This is because stb files load assets based in index, not by filename.<br>

<h1>STB Basics</h1>

STB files are separated into different "blocks" that can represent different "objects". The available blocks in the format are:

- JFVB (function value block)<br>
- JCMR (camera)<br>
- JABL (ambient light)<br>
- JACT (actor)<br>
- JSND (sound)<br>
- JLIT (light)<br>
- JCNT (control)<br>
- JMSG (message)<br>
- JFOG (fog)<br>
- JPTC (particle)<br>

Pikmin 2 only uses JFVB, JCMR, JCNT, JACT, JMSG, and JSND (which are the blocks that are going to be covered here), though the other blocks are theoretically supported. (note STB2JSON only supports the blocks vanilla uses) Particles are instead actors with a special identifier (an @ symbol in front of the name of the actor)

An object contains a list of "commands":

* "VAR" to bind a value/function to a variable
* "SET" to directly affect a properties of the bound object
* "WAIT" to halt the execution of the object for a certain amount of frames
* "SYNC" to halt the execution of the object until an event, external to the STB, is fired
* "OFLG", "XFLG" and "AFLG" to OR/XOR/AND the stb flags with a value

Each object has a set of "variables", which are bound to a properties of the object. A value/function can be bound to a variable using the "VAR" command:

"VAR (VarName) (Value/function) (Data)",

The value/function types are:

Void, to write a 0 to the variable<br>
Immediate, to write a direct value to the variable (specified in (Data))<br>
Time, to write a direct value, that is multiplied by the number of frames since the last "WAIT" command multiplied by 0.03333333, to the variable (specified in (Data))<br>
Index, to attach a JFVB function to the variable (the function index is specified in (Data)).<br>

A variable can affect more than one value of the bound object, in this case, the (Data) field
will have more than 1 value.<br>
After the delay of a "WAIT" command has passed, ALL value/function will be unbound from the
variables.

An object's name is defined by the "Type" field.

The JFVB block is the only one that does not represent objects. Instead, it holds "functions" all that represent data and how it evolves over time. There are two main types of functions used: "Constant", which contains a value that never changes, and "Hermite", which contains a value that changes following Hermite interpolation.
This is where values such as animation translation data and camera coordinates are stored.

A group of values typically looks like this:
<pre>
{
"Func": "Hermite",
"Range": "0.0 12.966666",
"Data": [
[
"0.0",
"70.229546",
"0.0",
[
"12.966666",
"188.07487",
"0.0",
],
]
},</pre>

The range is typically the start and end frames of the movement, if the value is not a constant value. To convert between the time values in range and frames, divide the frame number by 0.03333333.<br>
in this example, 12.966666 becomes roughly frame 389. To convert frames to time, multiply by 0.03333333.

Each subgroup of values has three floats. The first one is the time, the second is the value of whatever you're putting (camera coordinates, animation translation data, etc), and the third is the tangent value for the hermite interpolation. Setting tangent values to 0.0 will result in a smooth ease.

<h1>Camera</h1>

Note when getting camera coordinates, the position coordinates and target coordinates will be relative to the origin of the cutscene's location (wherever it is activated). The origin of a cutscene is specified in <code>user/Mukki/movie/demos.txt</code>, and that value will need to be accounted for when getting coordinate values. <br>
Position flags are also important to note too.<br>

A position flag of 2 the origin and camera angle specified in demos.txt (both value are confusingly named origin in the file, but the origin is the one with three floats and the angle is the one with one float)<br>
A position flag of 4 or 8 will use the origin and camera angle specified in the code that plays the specific cutscene. (8 specifically will also try to get the best camera angle for the cutscene when played)<br>
A position flag of 16 will do the same as 4 & 8, in addition to taking into account the sound position of certain objects in the cutscene (specified in code)<br>

For this example, we will be using a cutscene with an origin of <code>0.0, 0.0, 0.0</code>, and we will use the pikmin 2 gen editor to get coordinates, where values will be relative to <code>0.0, 0.0, 0.0</code> of the map's origin (which will serve as our cutscene origin, as the position flag is set to 2).
Let's start making our stb. It's a good idea to start by getting a vanilla stb, and converting it to json, then editing our own values in.<br>
First, we're just doing camera, so delete everything aside from the JFVB and JCMR blocks.

To setup our camera block, input this information:

<pre>"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},</pre>

Setting the Type to "camera" will set the camera.<br>

Camera variables are:<br>

* ProjFovy - the field of view (FOV) of the camera. (float)
* ViewRoll - the rotation of the camera. (float)
* ViewPos - the XYZ position of the camera in the world. (float)
* TargPos - the XYZ position of where the camera is looking in the world. (float)
* Distance - the culling distance of the camera. It is usually set to <code>1.0 12800.0</code> (near distance, far distance) (float)

The indexes here correspond to values in the function value block. For instance, TargPos index 7 will have the Z coordinate of where the camera is looking take the values from the eighth group in the JFVB block.<br>
The index counts from 0.

Let's start setting some values. Our first value (ProjFovy) will be the FOV of our camera. We want to keep it a constant value, so well have our first FVB group look like this:
<pre>
{ (this is the bracket for the start of our JSON)
"JFVB": { (this is the bracket for the start of the JFVB block)
"Values": [ (this is the bracket for the start of all data values in the block)
{
"Func": "Constant",
"Data": "45.0",
},</pre>

Our next group will be rotation values. As before, we want to keep this constant.
<pre>
{
"Func": "Constant",
"Data": "0.0",
},</pre>

Our JSON should now look like this:
<pre>
{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},

}</pre>

Now it's time to get position coordinates from the gen editor. Open up the files for the valley of Repose, as that is the location of where our cutscene is.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage1.png
</gallery>
Place a reference object for the first set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage2.png
</gallery>
Copy the XYZ coordinates of the object into the JSON. They should be in the third (X), fourth (Y), and fifth (Z) set of values as Hermite functions. <br>
The first time value should be 0.0, for the start of the cutscene. Make sure the range is from frames 0 to 565 (converted to time).
<pre>
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
]
},</pre>

Place a reference object for the second set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage3.png
</gallery>
Copy the XYZ coordinates of the second object into the JSON as the second set in the value groups.
The time value should be 18.83333145 (frame 565), for the end of the cutscene.
<pre>{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},</pre>
Now for the target coordinates. It helps to move your position in the gen editor to one of your position reference objects, to get a betteer view of where you want your camera to look.<br>
Place a reference object for your target coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage4.png
</gallery>
We'll use a Constant function for the target, since we currently do not want where the camera is looking to change.
Copy the XYZ coordinates of the object into the JSON. They should be in the sixth (X), seventh (Y), and eighth (Z) set of values.<br>

<pre>{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
](this is the bracket for the end of all data values in the block)
},(this is the bracket for the end of the JFVB block)</pre>

This is what your JSON should look like now:

<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
}</pre>

Now you can save your JSON, use STB2JSON to convert it to STB, then repack the cutscene archive.
If everything was done correctly, it should look like this ingame:
<gallery mode="packed-hover" widths=400px heights=400px>
File:cutscene1.gif
</gallery>

<h1>Actors (and particles)</h1>

Actors are the most complicated part of cutscenes, so we'll need to break a few things down. <br>

There are four main types of actors:

Game Actors, which are certain creatures in the game world (like navis and onions). These are denoted with a <code>*</code> symbol in front of the actor's name. <br>
Special Actors, which are actors that can activate certain commands. These are denoted with a <code>+</code> symbol in front of the actor's name. <br>
Particle Actors, which are particles. These are denoted with a <code>@</code> symbol in front of the actor's name. <br>
Actors, which are regular models placed in a cutscene. These are denoted with a <code>p</code> symbol in front of the actor's name, though this doesn't seem to be required. <br>

Sound effects are not part of the JACT block, but behave similarly to actors. These are denoted with a <code>#</code> symbol in front of the actor's name.

<h3>Game Actors</h3>

For Game Actors, each one has an identifier:

* <code>"theOrima"</code> is Olimar.
* <code>"theLouie"</code> is Louie/President.
* <code>"orimaAlive_1"</code> is the first alive leader.
* <code>"orimaAlive_2"</code> is the second alive leader.
* <code>"orimaDead_1"</code> is the first dead leader.
* <code>"orimaDead_2"</code> is the second dead leader.
* <code>"onyon_R"</code> is the Red Onion.
* <code>"onyon_Y"</code> is the Yellow Onion.
* <code>"onyon_B"</code> is the Blue Onion.
* <code>"ufo"</code> is the Hocotate Ship.
* <code>"pod"</code> is the Research Pod.
* <code>"pikmin"</code> is the target of the cutscene, if that target is a Pikmin.
* <code>"orima"</code> or "player" is the current active player.
* <code>"target</code>" is the target of the cutscene.

Game Actor variables are:

* Translation - the XYZ actor position offset from the movie position. (float)
* Rotation - the XYZ rotation of the actor relative to the actor's default orientation. Only the Y value seems to be used (float)

Game Actor properties are:

* AnimData
* Anim
* MovieTranslation

AnimData sets the index of the BCK data in the cutscene archive that will be applied to the creature it's set to affect. (int)
Anim sets which animation will be used. Setting Anim to "BCK" will use the BCK, while setting it to "None" will use the creature's base animation archive. (string)

Here's an example from the unused red onion boot cutscene:
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"SET MovieTranslation None",
"SET Anim None",
"SET AnimData 4",

</pre>

Here, Anim is set to None, so the animation will instead come from the onion's animations, and AnimData being set to 4 (counting from 0) will have the onion perform the fifth animation in the onion's <code>animmgr.txt</code>, which is <code>bootup.bck.</code><br>

MovieTranslation defines how translation will be applied to the actor (string):

* "None" wont do anything,
* "Direct" will directly copy the translation to the actor position,
* "MinY" will directly copy the X and Z translations to the actor position, but set the Y position to the map's minimum Y,
* "FaceDir" will directly copy the translation to the actor position and copy the Y value of the Rotation variable to the direction the actor is facing,
* "MoviePos" will copy the movie position to the actor position.

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*theLouie",
"Commands": [
"VAR Translation Index 16 17 18",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 3",
"WAIT 70",
"VAR Translation Index 19 20 21",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 4",
"WAIT 350",
]
},</pre>
Here, our actor is <code>*theLouie</code> (Louie), the first set of translation (in this case, movement of Louie's model) coordinates come from the value groups at indexes 16, 17, 18 (counting from 0) in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fourth (0, 1, 2, 3) file in the archive as the animation.
<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage1.png
</gallery>
After waiting 70 frames (and after the textbox is cleared) the second set of translation coordinates come from the value groups at indexes 19, 20, 21 in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fifth (0, 1, 2, 3, 4) file in the archive as the animation.<br>

Translation coordinates can be obtained the same way as obtaining camera position coordinates. <br>

Onions (including the ship and pod), navis, underground cave holes, and geysers also have their own special properties that serve as commands that can be set. <br>

(note: the format for these identifiers is hex value/JSON name)<br>

Onions<br>

* 0x64/CreateHead1 - create sprout
* 0x65/Spot - starts onion/ship/pod spot effect
* 0x66/SpotState - stops onion/ship/pod spot effect
* 0x67/StartPropera - start ship propeller animation
* 0x68/StopPropera - stop ship propeller animation
* 0x69/CreateHead2 - create sprout

Navi <br>

* 0x64/EnterPikis - make Pikmin go into the onion/ship
* 0x66/HoleInPikis - make Pikmin go into a cave hole
* 0x67/FountainPikis - make Pikmin jump onto a geyser
* 0x68/DelShadow - hide leader shadow
* 0x69/DelParticles - hide leader particles
* 0x6a/AddParticles - show leader particles
* 0x6b/AddShadow - show leader shadow

Hole<br>

* 0x64 - make hole appear

Geyser

* 0x64 - make geyser appear

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"WAIT 105",
"SET CreateHead2",
"WAIT 315",
]
},</pre>

<h3>Particle Actors</h3>

Particle Actors are particles, getting their data from the <code>efx.jpc</code> included in the cutscene archive.

Particle actors have two properties:

* Parc - the particle ID (Short) and the particle list index (Byte) in the JPC.
* Targ - the object on which the particle will appear. If a second string is specified, the particle will appear on the object's model joint specified by the second string

Example:

<pre>"JACT": {
"Type": "@boot_gr_b",
"Commands": [
"SET Parc 5 5",
"SET Targ *onyon_R",
"WAIT 390",
]
},
"JACT": {
"Type": "@boot_gr_o",
"Commands": [
"SET Parc 6 5",
"SET Targ *onyon_R body_1",
"WAIT 390",
]
},</pre>

Particles have three variables:<br>

* Translation - XYZ position offset from the position of the object it is attached to, or the cutscene position if not attached to an object.(float)
* Rotation - XYZ rotation relative to the particle's default orientation(float)
* Scaling - XYZ size relative to the particle's default size(float)

If "ground" is the second string, the particle will uses the object position and ignore the object matrix.

<h3>Special Actors</h3>

Special Actors are actors that can affect parts of the game and execute special commands. They are usually context sensitive.<br>

The properties (commands) are:<br>

* 0x00/LeaveCave - abandon treasures and pikmin when giving up
* 0x01/DayEnd - create day end enemies, spawn left behind Pikmin
* 0x02/FallPikiSound - start falling Pikmin sound effects in cave entry
* 0x03/ForceEnterPiki - force Pikmin into the Onion on day 1
* 0x65/StartDemoCamera - start "demo" camera type (using the regular game camera instead of the cutscene camera)
* 0x66/EndDemoCamera - go back to normal player camera
* 0xC9/OpenKentei - open treasure collection UI (res_kantei)
* 0xCB/OpenKentei - open treasure collection UI (res_kantei)
* 0x12D/FadeOut - fade the screen
* 0x12E/FadeIn - unfade the screen

Example:
<pre>"JACT": {
"Type": "+MovieCommand",
"Commands": [
"SET FallPikiSound",
"WAIT 219",
]
},</pre>

When the StartDemoCamera command is used, the cutscene will use the game's camera rather than the cutscene camera. This is mainly seen in <code>s03_orimadown</code>.

<h3>Actors</h3>

Actors are regular models that can appear in a cutscene.

Actor properties are:

* BCKIdx - sets the index of the BCK data in the cutscene archive that will be applied to the actor it's set to affect. (int)
* BMDIdx - sets the index of the BMD model the actor will use. (int)

Actor variables are

* Translation - the XYZ actor position offset from the movie position. (float)
* Scaling - the XYZ actor size relative to its default model size. (float)
* Rotation - the XYZ actor rotation relative to its default orientation. (float)<br>

Now that we've absorbed all that, let's add some actors to our cutscene.<br>

We're going to add Olimar, and have him play the down animation from <code>s03_orimadown</code>. We'll keep him stationary.

<pre>"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},</pre>

Note: because we don't have any translation going on here, olimar will be spawned where he would be spawned in regular gameplay.

<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage2.png
</gallery>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Actortutorialimage3.png
</gallery>

<h1>Sounds and messages</h1>

Message blocks are usually paired with a control block, presumably to halt things until the text box is done.<br>

<pre>"JMSG": {
"Type": "メッセージ",
"Commands": [
"WAIT 88",
"SET Code 894 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "コントロール",
"Commands": [
"WAIT 89",
"SYNC 1",
"WAIT 1",
]
},</pre>
The Type for messages is always "メッセージ" ("message"), and the Type for control is always "コントロール" ("control"). If there is more than one message/control in a cutscene, a number will follow the text (e.g. "メッセージ２" for the second message). Note that these aren't required, and currently, replacing the japanese text with english is needed for the rebuilding to not make a malformed STB.
Note the Code being set for the message block. The first three digits (short) are the message index (in decimal) in the [[BMG_file|BMG]]. The last digit (short) is the sub index of the message.

Sounds have two major components: Music, which is handled outside the STB, and sound effects, which for the most part are handled inside the STB.<br>

It's still worth mentioning some things about music:<br>

Which AST that is associated with which cutscene is controlled by <code>PSM::Demo::initiate</code> (in utilityU/PSMainSide_Demo.cpp) in the game's code. The function checks for a cutscene's name, then associates a stream file ID with it.

In vanilla, two cutscenes (<code>x20_blackman</code> and <code>x03_find_red_onyon</code>) are coded not to start with music initially. For the latter cutscene, audio is coded to start after the first text box has been closed.

Now about the other part of cutscene audio: Sound effects.<br>
This is what a typical sound block looks like:
<pre>"JSND": {
"Type": "#orimaAlive_2_1",
"Commands": [
"WAIT 335",
"SET Parent *orimaAlive_2",
"SET ParentNode happajnt3",
"SET ParentEnable True",
"SET Located True",
"SET ID 2161",
"SET BeginFadeIn 0.0",
"WAIT 12",
]
},</pre>

As stated earlier, a <code>#</code> in front of the name of the actor denotes a sound. <br>

Sound's properties are:

* Parent - binds the sound to an actor (in this case, the second alive player, or Louie) (string)
* ParentNode - further binds the sound to a specific joint on the model of the actor (string)
* ParentEnable - sets this binding to true. (boolean)
* Located - tells the sound to follow a position, whether from an attached creature or a direct position variable. (boolean)
* ID - the sound effect ID, in decimal. See [https://pikmintkb.com/wiki/Se.bms this page] for IDs. (int)
* Begin - starts the sound.
* BeginFadeIn - tells the sound to fade in when started, with the time it takes to fade in determined by the float after it.
* End - stops the sound.
* EndFadeOut - tells the sound to fade out when started, with the time it takes to fade out determined by the float after it.

Sound's variables are:

* Volume (float)
* Pan (float)
* Pitch (float)
* TempoProportion (float) - speed
* Fxmix (float) - reverb/echo
* Position (float) - XYZ sound position offset from the movie position

Let's add a sound effect and a text box to our cutscene. <br>

Text box first, we'll use message index 915 (in the BMG, this will show as hex, so it's actually 0x393) and have it appear at the end of the cutscene.

<pre>"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},</pre>

Due to a seemingly hardware dependent bug, the stb created by STB2JSON may have the "control block" represented as <code>0xEFBFBDEFBFBDEFBFBDEFBFBD</code> instead of <code>0xFFFFFFFF</code>, which is the correct one. If this happens, open your stb in a hex editor and change the offending bytes, making sure to delete the extra bytes.
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage1.png
</gallery>
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage2.png
</gallery>
Now let's test in game. <br>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Messagetutorialimage3.png
</gallery>

Finally, let's add a sound. Let's play <code>PSSE_SY_WMAP_MONEY_UP</code> (one of the ka-ching sounds)
We're not going to tie it to any actor, just have it play on its own.

<pre>"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},</pre>

Our whole JSON should now look like this:
<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},
"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},
"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},
}
</pre>
Convert your JSON to STB, remember to fix the control block if needed, repack your archive with WiiExplorer (make sure the file IDs are correct!), and play the cutscene in game.<br>

Congratulations, you have now made a full cutscene! Feel free to experiment with editing vanilla cutscenes, or making more of your own.

Cutscene Editing and Creation

2025-06-04T16:36:05Z

Iwillremembermypasswordthistime: we need a new tool assuming the game doesn't throw a fit either

This page will run through editing and creating your own cutscenes in Pikmin 2. <br>
Cutscenes use the JStudio library, which was used in Wind Waker, Twilight Princess, Pikmin 2, and Skyward Sword.<br>
In Pikmin 2, cutscenes are contained in <code>demo.szs</code> files in <code>user/Mukki/movie</code>.<br>
Inside these szs files are a few assets, most notably the JStudio Binary (STB) file. This file controls initialization of cutscene data, as well as camera instructions.<br>
We can use a program called [https://drive.google.com/file/d/1JNqFF1IuJgdwzNA3XvVUEapyCwc2xfvP STB2JSON] to convert this to a more readable format.<br>

Note when extracting cutscene archives, you must use a program like WiiExplorer that can preserve the file indexes. This is because stb files load assets based in index, not by filename.<br>

<h1>STB Basics</h1>

STB files are separated into different "blocks" that can represent different "objects". The available blocks in the format are:

- JFVB (function value block)<br>
- JCMR (camera)<br>
- JABL (ambient light)<br>
- JACT (actor)<br>
- JSND (sound)<br>
- JLIT (light)<br>
- JCNT (control)<br>
- JMSG (message)<br>
- JFOG (fog)<br>
- JPTC (particle)<br>

Pikmin 2 only uses JFVB, JCMR, JCNT, JACT, JMSG, and JSND (which are the blocks that are going to be covered here), though the other blocks are theoretically supported. (note STB2JSON only supports the blocks vanilla uses) Particles are instead actors with a special identifier (an @ symbol in front of the name of the actor)

An object contains a list of "commands":

* "VAR" to bind a value/function to a variable
* "SET" to directly affect a properties of the bound object
* "WAIT" to halt the execution of the object for a certain amount of frames
* "SYNC" to halt the execution of the object until an event, external to the STB, is fired
* "OFLG", "XFLG" and "AFLG" to OR/XOR/AND the stb flags with a value

Each object has a set of "variables", which are bound to a properties of the object. A value/function can be bound to a variable using the "VAR" command:

"VAR (VarName) (Value/function) (Data)",

The value/function types are:

Void, to write a 0 to the variable<br>
Immediate, to write a direct value to the variable (specified in (Data))<br>
Time, to write a direct value, that is multiplied by the number of frames since the last "WAIT" command multiplied by 0.03333333, to the variable (specified in (Data))<br>
Index, to attach a JFVB function to the variable (the function index is specified in (Data)).<br>

A variable can affect more than one value of the bound object, in this case, the (Data) field
will have more than 1 value.<br>
After the delay of a "WAIT" command has passed, ALL value/function will be unbound from the
variables.

An object's name is defined by the "Type" field.

The JFVB block is the only one that does not represent objects. Instead, it holds "functions" all that represent data and how it evolves over time. There are two main types of functions used: "Constant", which contains a value that never changes, and "Hermite", which contains a value that changes following Hermite interpolation.
This is where values such as animation translation data and camera coordinates are stored.

A group of values typically looks like this:
<pre>
{
"Func": "Hermite",
"Range": "0.0 12.966666",
"Data": [
[
"0.0",
"70.229546",
"0.0",
[
"12.966666",
"188.07487",
"0.0",
],
]
},</pre>

The range is typically the start and end frames of the movement, if the value is not a constant value. To convert between the time values in range and frames, divide the frame number by 0.03333333.<br>
in this example, 12.966666 becomes roughly frame 389. To convert frames to time, multiply by 0.03333333.

Each subgroup of values has three floats. The first one is the time, the second is the value of whatever you're putting (camera coordinates, animation translation data, etc), and the third is the tangent value for the hermite interpolation. Setting tangent values to 0.0 will result in a smooth ease.

<h1>Camera</h1>

Note when getting camera coordinates, the position coordinates and target coordinates will be relative to the origin of the cutscene's location (wherever it is activated). The origin of a cutscene is specified in <code>user/Mukki/movie/demos.txt</code>, and that value will need to be accounted for when getting coordinate values. <br>
Position flags are also important to note too.<br>

A position flag of 2 the origin and camera angle specified in demos.txt (both value are confusingly named origin in the file, but the origin is the one with three floats and the angle is the one with one float)<br>
A position flag of 4 or 8 will use the origin and camera angle specified in the code that plays the specific cutscene. (8 specifically will also try to get the best camera angle for the cutscene when played)<br>
A position flag of 16 will do the same as 4 & 8, in addition to taking into account the sound position of certain objects in the cutscene (specified in code)<br>

For this example, we will be using a cutscene with an origin of <code>0.0, 0.0, 0.0</code>, and we will use the pikmin 2 gen editor to get coordinates, where values will be relative to <code>0.0, 0.0, 0.0</code> of the map's origin (which will serve as our cutscene origin, as the position flag is set to 2).
Let's start making our stb. It's a good idea to start by getting a vanilla stb, and converting it to json, then editing our own values in.<br>
First, we're just doing camera, so delete everything aside from the JFVB and JCMR blocks.

To setup our camera block, input this information:

<pre>"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},</pre>

Setting the Type to "camera" will set the camera.<br>

Camera variables are:<br>

* ProjFovy - the field of view (FOV) of the camera. (float)
* ViewRoll - the rotation of the camera. (float)
* ViewPos - the XYZ position of the camera in the world. (float)
* TargPos - the XYZ position of where the camera is looking in the world. (float)
* Distance - the culling distance of the camera. It is usually set to <code>1.0 12800.0</code> (near distance, far distance) (float)

The indexes here correspond to values in the function value block. For instance, TargPos index 7 will have the Z coordinate of where the camera is looking take the values from the eighth group in the JFVB block.<br>
The index counts from 0.

Let's start setting some values. Our first value (ProjFovy) will be the FOV of our camera. We want to keep it a constant value, so well have our first FVB group look like this:
<pre>
{ (this is the bracket for the start of our JSON)
"JFVB": { (this is the bracket for the start of the JFVB block)
"Values": [ (this is the bracket for the start of all data values in the block)
{
"Func": "Constant",
"Data": "45.0",
},</pre>

Our next group will be rotation values. As before, we want to keep this constant.
<pre>
{
"Func": "Constant",
"Data": "0.0",
},</pre>

Our JSON should now look like this:
<pre>
{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},

}</pre>

Now it's time to get position coordinates from the gen editor. Open up the files for the valley of Repose, as that is the location of where our cutscene is.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage1.png
</gallery>
Place a reference object for the first set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage2.png
</gallery>
Copy the XYZ coordinates of the object into the JSON. They should be in the third (X), fourth (Y), and fifth (Z) set of values as Hermite functions. <br>
The first time value should be 0.0, for the start of the cutscene. Make sure the range is from frames 0 to 565 (converted to time).
<pre>
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
]
},</pre>

Place a reference object for the second set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage3.png
</gallery>
Copy the XYZ coordinates of the second object into the JSON as the second set in the value groups.
The time value should be 18.83333145 (frame 565), for the end of the cutscene.
<pre>{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},</pre>
Now for the target coordinates. It helps to move your position in the gen editor to one of your position reference objects, to get a betteer view of where you want your camera to look.<br>
Place a reference object for your target coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage4.png
</gallery>
We'll use a Constant function for the target, since we currently do not want where the camera is looking to change.
Copy the XYZ coordinates of the object into the JSON. They should be in the sixth (X), seventh (Y), and eighth (Z) set of values.<br>

<pre>{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
](this is the bracket for the end of all data values in the block)
},(this is the bracket for the end of the JFVB block)</pre>

This is what your JSON should look like now:

<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
}</pre>

Now you can save your JSON, use STB2JSON to convert it to STB, then repack the cutscene archive.
If everything was done correctly, it should look like this ingame:
<gallery mode="packed-hover" widths=400px heights=400px>
File:cutscene1.gif
</gallery>

<h1>Actors (and particles)</h1>

Actors are the most complicated part of cutscenes, so we'll need to break a few things down. <br>

There are four main types of actors:

Game Actors, which are certain creatures in the game world (like navis and onions). These are denoted with a <code>*</code> symbol in front of the actor's name. <br>
Special Actors, which are actors that can activate certain commands. These are denoted with a <code>+</code> symbol in front of the actor's name. <br>
Particle Actors, which are particles. These are denoted with a <code>@</code> symbol in front of the actor's name. <br>
Actors, which are regular models placed in a cutscene. These are denoted with a <code>p</code> symbol in front of the actor's name, though this doesn't seem to be required. <br>

Sound effects are not part of the JACT block, but behave similarly to actors. These are denoted with a <code>#</code> symbol in front of the actor's name.

<h3>Game Actors</h3>

For Game Actors, each one has an identifier:

* <code>"theOrima"</code> is Olimar.
* <code>"theLouie"</code> is Louie/President.
* <code>"orimaAlive_1"</code> is the first alive leader.
* <code>"orimaAlive_2"</code> is the second alive leader.
* <code>"orimaDead_1"</code> is the first dead leader.
* <code>"orimaDead_2"</code> is the second dead leader.
* <code>"onyon_R"</code> is the Red Onion.
* <code>"onyon_Y"</code> is the Yellow Onion.
* <code>"onyon_B"</code> is the Blue Onion.
* <code>"ufo"</code> is the Hocotate Ship.
* <code>"pod"</code> is the Research Pod.
* <code>"pikmin"</code> is the target of the cutscene, if that target is a Pikmin.
* <code>"orima"</code> or "player" is the current active player.
* <code>"target</code>" is the target of the cutscene.

Game Actor variables are:

* Translation - the XYZ actor position offset from the movie position. (float)
* RotationY - the Y rotation of the actor (float)

Game Actor properties are:

* AnimData
* Anim
* MovieTranslation

AnimData sets the index of the BCK data in the cutscene archive that will be applied to the creature it's set to affect. (int)
Anim sets which animation will be used. Setting Anim to "BCK" will use the BCK, while setting it to "None" will use the creature's base animation archive. (string)

Here's an example from the unused red onion boot cutscene:
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"SET MovieTranslation None",
"SET Anim None",
"SET AnimData 4",

</pre>

Here, Anim is set to None, so the animation will instead come from the onion's animations, and AnimData being set to 4 (counting from 0) will have the onion perform the fifth animation in the onion's <code>animmgr.txt</code>, which is <code>bootup.bck.</code><br>

MovieTranslation defines how translation will be applied to the actor (string):

* "None" wont do anything,
* "Direct" will directly copy the translation to the actor position,
* "MinY" will directly copy the X and Z translations to the actor position, but set the Y position to the map's minimum Y,
* "FaceDir" will directly copy the translation to the actor position and copy the RotationY variable to the direction the actor is facing,
* "MoviePos" will copy the movie position to the actor position.

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*theLouie",
"Commands": [
"VAR Translation Index 16 17 18",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 3",
"WAIT 70",
"VAR Translation Index 19 20 21",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 4",
"WAIT 350",
]
},</pre>
Here, our actor is <code>*theLouie</code> (Louie), the first set of translation (in this case, movement of Louie's model) coordinates come from the value groups at indexes 16, 17, 18 (counting from 0) in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fourth (0, 1, 2, 3) file in the archive as the animation.
<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage1.png
</gallery>
After waiting 70 frames (and after the textbox is cleared) the second set of translation coordinates come from the value groups at indexes 19, 20, 21 in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fifth (0, 1, 2, 3, 4) file in the archive as the animation.<br>

Translation coordinates can be obtained the same way as obtaining camera position coordinates. <br>

Onions (including the ship and pod), navis, underground cave holes, and geysers also have their own special properties that serve as commands that can be set. <br>

(note: the format for these identifiers is hex value/JSON name)<br>

Onions<br>

* 0x64/CreateHead1 - create sprout
* 0x65/Spot - starts onion/ship/pod spot effect
* 0x66/SpotState - stops onion/ship/pod spot effect
* 0x67/StartPropera - start ship propeller animation
* 0x68/StopPropera - stop ship propeller animation
* 0x69/CreateHead2 - create sprout

Navi <br>

* 0x64/EnterPikis - make Pikmin go into the onion/ship
* 0x66/HoleInPikis - make Pikmin go into a cave hole
* 0x67/FountainPikis - make Pikmin jump onto a geyser
* 0x68/DelShadow - hide leader shadow
* 0x69/DelParticles - hide leader particles
* 0x6a/AddParticles - show leader particles
* 0x6b/AddShadow - show leader shadow

Hole<br>

* 0x64 - make hole appear

Geyser

* 0x64 - make geyser appear

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"WAIT 105",
"SET CreateHead2",
"WAIT 315",
]
},</pre>

<h3>Particle Actors</h3>

Particle Actors are particles, getting their data from the <code>efx.jpc</code> included in the cutscene archive.

Particle actors have two properties:

* Parc - the particle ID (Short) and the particle list index (Byte) in the JPC.
* Targ - the object on which the particle will appear. If a second string is specified, the particle will appear on the object's model joint specified by the second string

Example:

<pre>"JACT": {
"Type": "@boot_gr_b",
"Commands": [
"SET Parc 5 5",
"SET Targ *onyon_R",
"WAIT 390",
]
},
"JACT": {
"Type": "@boot_gr_o",
"Commands": [
"SET Parc 6 5",
"SET Targ *onyon_R body_1",
"WAIT 390",
]
},</pre>

Particles have three variables:<br>

* Translation - XYZ position offset from the position of the object it is attached to, or the cutscene position if not attached to an object.(float)
* Rotation - XYZ rotation relative to the particle's default orientation(float)
* Scaling - XYZ size relative to the particle's default size(float)

If "ground" is the second string, the particle will uses the object position and ignore the object matrix.

<h3>Special Actors</h3>

Special Actors are actors that can affect parts of the game and execute special commands. They are usually context sensitive.<br>

The properties (commands) are:<br>

* 0x00/LeaveCave - abandon treasures and pikmin when giving up
* 0x01/DayEnd - create day end enemies, spawn left behind Pikmin
* 0x02/FallPikiSound - start falling Pikmin sound effects in cave entry
* 0x03/ForceEnterPiki - force Pikmin into the Onion on day 1
* 0x65/StartDemoCamera - start "demo" camera type (using the regular game camera instead of the cutscene camera)
* 0x66/EndDemoCamera - go back to normal player camera
* 0xC9/OpenKentei - open treasure collection UI (res_kantei)
* 0xCB/OpenKentei - open treasure collection UI (res_kantei)
* 0x12D/FadeOut - fade the screen
* 0x12E/FadeIn - unfade the screen

Example:
<pre>"JACT": {
"Type": "+MovieCommand",
"Commands": [
"SET FallPikiSound",
"WAIT 219",
]
},</pre>

When the StartDemoCamera command is used, the cutscene will use the game's camera rather than the cutscene camera. This is mainly seen in <code>s03_orimadown</code>.

<h3>Actors</h3>

Actors are regular models that can appear in a cutscene.

Actor properties are:

* BCKIdx - sets the index of the BCK data in the cutscene archive that will be applied to the actor it's set to affect. (int)
* BMDIdx - sets the index of the BMD model the actor will use. (int)

Actor variables are

* Translation - the XYZ actor position offset from the movie position. (float)
* Scaling - the XYZ actor size relative to its default model size. (float)
* Rotation - the XYZ actor rotation relative to its default orientation. (float)<br>

Now that we've absorbed all that, let's add some actors to our cutscene.<br>

We're going to add Olimar, and have him play the down animation from <code>s03_orimadown</code>. We'll keep him stationary.

<pre>"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},</pre>

Note: because we don't have any translation going on here, olimar will be spawned where he would be spawned in regular gameplay.

<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage2.png
</gallery>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Actortutorialimage3.png
</gallery>

<h1>Sounds and messages</h1>

Message blocks are usually paired with a control block, presumably to halt things until the text box is done.<br>

<pre>"JMSG": {
"Type": "メッセージ",
"Commands": [
"WAIT 88",
"SET Code 894 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "コントロール",
"Commands": [
"WAIT 89",
"SYNC 1",
"WAIT 1",
]
},</pre>
The Type for messages is always "メッセージ" ("message"), and the Type for control is always "コントロール" ("control"). If there is more than one message/control in a cutscene, a number will follow the text (e.g. "メッセージ２" for the second message). Note that these aren't required, and currently, replacing the japanese text with english is needed for the rebuilding to not make a malformed STB.
Note the Code being set for the message block. The first three digits (short) are the message index (in decimal) in the [[BMG_file|BMG]]. The last digit (short) is the sub index of the message.

Sounds have two major components: Music, which is handled outside the STB, and sound effects, which for the most part are handled inside the STB.<br>

It's still worth mentioning some things about music:<br>

Which AST that is associated with which cutscene is controlled by <code>PSM::Demo::initiate</code> (in utilityU/PSMainSide_Demo.cpp) in the game's code. The function checks for a cutscene's name, then associates a stream file ID with it.

In vanilla, two cutscenes (<code>x20_blackman</code> and <code>x03_find_red_onyon</code>) are coded not to start with music initially. For the latter cutscene, audio is coded to start after the first text box has been closed.

Now about the other part of cutscene audio: Sound effects.<br>
This is what a typical sound block looks like:
<pre>"JSND": {
"Type": "#orimaAlive_2_1",
"Commands": [
"WAIT 335",
"SET Parent *orimaAlive_2",
"SET ParentNode happajnt3",
"SET ParentEnable True",
"SET Located True",
"SET ID 2161",
"SET BeginFadeIn 0.0",
"WAIT 12",
]
},</pre>

As stated earlier, a <code>#</code> in front of the name of the actor denotes a sound. <br>

Sound's properties are:

* Parent - binds the sound to an actor (in this case, the second alive player, or Louie) (string)
* ParentNode - further binds the sound to a specific joint on the model of the actor (string)
* ParentEnable - sets this binding to true. (boolean)
* Located - tells the sound to follow a position, whether from an attached creature or a direct position variable. (boolean)
* ID - the sound effect ID, in decimal. See [https://pikmintkb.com/wiki/Se.bms this page] for IDs. (int)
* Begin - starts the sound.
* BeginFadeIn - tells the sound to fade in when started, with the time it takes to fade in determined by the float after it.
* End - stops the sound.
* EndFadeOut - tells the sound to fade out when started, with the time it takes to fade out determined by the float after it.

Sound's variables are:

* Volume (float)
* Pan (float)
* Pitch (float)
* TempoProportion (float) - speed
* Fxmix (float) - reverb/echo
* Position (float) - XYZ sound position offset from the movie position

Let's add a sound effect and a text box to our cutscene. <br>

Text box first, we'll use message index 915 (in the BMG, this will show as hex, so it's actually 0x393) and have it appear at the end of the cutscene.

<pre>"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},</pre>

Due to a seemingly hardware dependent bug, the stb created by STB2JSON may have the "control block" represented as <code>0xEFBFBDEFBFBDEFBFBDEFBFBD</code> instead of <code>0xFFFFFFFF</code>, which is the correct one. If this happens, open your stb in a hex editor and change the offending bytes, making sure to delete the extra bytes.
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage1.png
</gallery>
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage2.png
</gallery>
Now let's test in game. <br>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Messagetutorialimage3.png
</gallery>

Finally, let's add a sound. Let's play <code>PSSE_SY_WMAP_MONEY_UP</code> (one of the ka-ching sounds)
We're not going to tie it to any actor, just have it play on its own.

<pre>"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},</pre>

Our whole JSON should now look like this:
<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},
"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},
"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},
}
</pre>
Convert your JSON to STB, remember to fix the control block if needed, repack your archive with WiiExplorer (make sure the file IDs are correct!), and play the cutscene in game.<br>

Congratulations, you have now made a full cutscene! Feel free to experiment with editing vanilla cutscenes, or making more of your own.

Cutscene Editing and Creation

2025-06-04T16:17:53Z

Iwillremembermypasswordthistime: position flags explanation

This page will run through editing and creating your own cutscenes in Pikmin 2. <br>
Cutscenes use the JStudio library, which was used in Wind Waker, Twilight Princess, Pikmin 2, and Skyward Sword.<br>
In Pikmin 2, cutscenes are contained in <code>demo.szs</code> files in <code>user/Mukki/movie</code>.<br>
Inside these szs files are a few assets, most notably the JStudio Binary (STB) file. This file controls initialization of cutscene data, as well as camera instructions.<br>
We can use a program called [https://drive.google.com/file/d/1JNqFF1IuJgdwzNA3XvVUEapyCwc2xfvP STB2JSON] to convert this to a more readable format.<br>

Note when extracting cutscene archives, you must use a program like WiiExplorer that can preserve the file indexes. This is because stb files load assets based in index, not by filename.<br>

<h1>STB Basics</h1>

STB files are separated into different "blocks" that can represent different "objects". The available blocks in the format are:

- JFVB (function value block)<br>
- JCMR (camera)<br>
- JABL (ambient light)<br>
- JACT (actor)<br>
- JSND (sound)<br>
- JLIT (light)<br>
- JCNT (control)<br>
- JMSG (message)<br>
- JFOG (fog)<br>
- JPTC (particle)<br>

Pikmin 2 only uses JFVB, JCMR, JCNT, JACT, JMSG, and JSND (which are the blocks that are going to be covered here), though the other blocks are supported. Particles are instead actors with a special identifier (an @ symbol in front of the name of the actor)

An object contains a list of "commands":

* "VAR" to bind a value/function to a variable
* "SET" to directly affect a properties of the bound object
* "WAIT" to halt the execution of the object for a certain amount of frames
* "SYNC" to halt the execution of the object until an event, external to the STB, is fired
* "OFLG", "XFLG" and "AFLG" to OR/XOR/AND the stb flags with a value

Each object has a set of "variables", which are bound to a properties of the object. A value/function can be bound to a variable using the "VAR" command:

"VAR (VarName) (Value/function) (Data)",

The value/function types are:

Void, to write a 0 to the variable<br>
Immediate, to write a direct value to the variable (specified in (Data))<br>
Time, to write a direct value, that is multiplied by the number of frames since the last "WAIT" command multiplied by 0.03333333, to the variable (specified in (Data))<br>
Index, to attach a JFVB function to the variable (the function index is specified in (Data)).<br>

A variable can affect more than one value of the bound object, in this case, the (Data) field
will have more than 1 value.<br>
After the delay of a "WAIT" command has passed, ALL value/function will be unbound from the
variables.

An object's name is defined by the "Type" field.

The JFVB block is the only one that does not represent objects. Instead, it holds "functions" all that represent data and how it evolves over time. There are two main types of functions used: "Constant", which contains a value that never changes, and "Hermite", which contains a value that changes following Hermite interpolation.
This is where values such as animation translation data and camera coordinates are stored.

A group of values typically looks like this:
<pre>
{
"Func": "Hermite",
"Range": "0.0 12.966666",
"Data": [
[
"0.0",
"70.229546",
"0.0",
[
"12.966666",
"188.07487",
"0.0",
],
]
},</pre>

The range is typically the start and end frames of the movement, if the value is not a constant value. To convert between the time values in range and frames, divide the frame number by 0.03333333.<br>
in this example, 12.966666 becomes roughly frame 389. To convert frames to time, multiply by 0.03333333.

Each subgroup of values has three floats. The first one is the time, the second is the value of whatever you're putting (camera coordinates, animation translation data, etc), and the third is the tangent value for the hermite interpolation. Setting tangent values to 0.0 will result in a smooth ease.

<h1>Camera</h1>

Note when getting camera coordinates, the position coordinates and target coordinates will be relative to the origin of the cutscene's location (wherever it is activated). The origin of a cutscene is specified in <code>user/Mukki/movie/demos.txt</code>, and that value will need to be accounted for when getting coordinate values. <br>
Position flags are also important to note too.<br>

A position flag of 2 the origin and camera angle specified in demos.txt (both value are confusingly named origin in the file, but the origin is the one with three floats and the angle is the one with one float)<br>
A position flag of 4 or 8 will use the origin and camera angle specified in the code that plays the specific cutscene. (8 specifically will also try to get the best camera angle for the cutscene when played)<br>
A position flag of 16 will do the same as 4 & 8, in addition to taking into account the sound position of certain objects in the cutscene (specified in code)<br>

For this example, we will be using a cutscene with an origin of <code>0.0, 0.0, 0.0</code>, and we will use the pikmin 2 gen editor to get coordinates, where values will be relative to <code>0.0, 0.0, 0.0</code> of the map's origin (which will serve as our cutscene origin, as the position flag is set to 2).
Let's start making our stb. It's a good idea to start by getting a vanilla stb, and converting it to json, then editing our own values in.<br>
First, we're just doing camera, so delete everything aside from the JFVB and JCMR blocks.

To setup our camera block, input this information:

<pre>"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},</pre>

Setting the Type to "camera" will set the camera.<br>

Camera variables are:<br>

* ProjFovy - the field of view (FOV) of the camera. (float)
* ViewRoll - the rotation of the camera. (float)
* ViewPos - the XYZ position of the camera in the world. (float)
* TargPos - the XYZ position of where the camera is looking in the world. (float)
* Distance - the culling distance of the camera. It is usually set to <code>1.0 12800.0</code> (near distance, far distance) (float)

The indexes here correspond to values in the function value block. For instance, TargPos index 7 will have the Z coordinate of where the camera is looking take the values from the eighth group in the JFVB block.<br>
The index counts from 0.

Let's start setting some values. Our first value (ProjFovy) will be the FOV of our camera. We want to keep it a constant value, so well have our first FVB group look like this:
<pre>
{ (this is the bracket for the start of our JSON)
"JFVB": { (this is the bracket for the start of the JFVB block)
"Values": [ (this is the bracket for the start of all data values in the block)
{
"Func": "Constant",
"Data": "45.0",
},</pre>

Our next group will be rotation values. As before, we want to keep this constant.
<pre>
{
"Func": "Constant",
"Data": "0.0",
},</pre>

Our JSON should now look like this:
<pre>
{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},

}</pre>

Now it's time to get position coordinates from the gen editor. Open up the files for the valley of Repose, as that is the location of where our cutscene is.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage1.png
</gallery>
Place a reference object for the first set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage2.png
</gallery>
Copy the XYZ coordinates of the object into the JSON. They should be in the third (X), fourth (Y), and fifth (Z) set of values as Hermite functions. <br>
The first time value should be 0.0, for the start of the cutscene. Make sure the range is from frames 0 to 565 (converted to time).
<pre>
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
]
},</pre>

Place a reference object for the second set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage3.png
</gallery>
Copy the XYZ coordinates of the second object into the JSON as the second set in the value groups.
The time value should be 18.83333145 (frame 565), for the end of the cutscene.
<pre>{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},</pre>
Now for the target coordinates. It helps to move your position in the gen editor to one of your position reference objects, to get a betteer view of where you want your camera to look.<br>
Place a reference object for your target coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage4.png
</gallery>
We'll use a Constant function for the target, since we currently do not want where the camera is looking to change.
Copy the XYZ coordinates of the object into the JSON. They should be in the sixth (X), seventh (Y), and eighth (Z) set of values.<br>

<pre>{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
](this is the bracket for the end of all data values in the block)
},(this is the bracket for the end of the JFVB block)</pre>

This is what your JSON should look like now:

<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
}</pre>

Now you can save your JSON, use STB2JSON to convert it to STB, then repack the cutscene archive.
If everything was done correctly, it should look like this ingame:
<gallery mode="packed-hover" widths=400px heights=400px>
File:cutscene1.gif
</gallery>

<h1>Actors (and particles)</h1>

Actors are the most complicated part of cutscenes, so we'll need to break a few things down. <br>

There are four main types of actors:

Game Actors, which are certain creatures in the game world (like navis and onions). These are denoted with a <code>*</code> symbol in front of the actor's name. <br>
Special Actors, which are actors that can activate certain commands. These are denoted with a <code>+</code> symbol in front of the actor's name. <br>
Particle Actors, which are particles. These are denoted with a <code>@</code> symbol in front of the actor's name. <br>
Actors, which are regular models placed in a cutscene. These are denoted with a <code>p</code> symbol in front of the actor's name, though this doesn't seem to be required. <br>

Sound effects are not part of the JACT block, but behave similarly to actors. These are denoted with a <code>#</code> symbol in front of the actor's name.

<h3>Game Actors</h3>

For Game Actors, each one has an identifier:

* <code>"theOrima"</code> is Olimar.
* <code>"theLouie"</code> is Louie/President.
* <code>"orimaAlive_1"</code> is the first alive leader.
* <code>"orimaAlive_2"</code> is the second alive leader.
* <code>"orimaDead_1"</code> is the first dead leader.
* <code>"orimaDead_2"</code> is the second dead leader.
* <code>"onyon_R"</code> is the Red Onion.
* <code>"onyon_Y"</code> is the Yellow Onion.
* <code>"onyon_B"</code> is the Blue Onion.
* <code>"ufo"</code> is the Hocotate Ship.
* <code>"pod"</code> is the Research Pod.
* <code>"pikmin"</code> is the target of the cutscene, if that target is a Pikmin.
* <code>"orima"</code> or "player" is the current active player.
* <code>"target</code>" is the target of the cutscene.

Game Actor variables are:

* Translation - the XYZ actor position offset from the movie position. (float)
* RotationY - the Y rotation of the actor (float)

Game Actor properties are:

* AnimData
* Anim
* MovieTranslation

AnimData sets the index of the BCK data in the cutscene archive that will be applied to the creature it's set to affect. (int)
Anim sets which animation will be used. Setting Anim to "BCK" will use the BCK, while setting it to "None" will use the creature's base animation archive. (string)

Here's an example from the unused red onion boot cutscene:
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"SET MovieTranslation None",
"SET Anim None",
"SET AnimData 4",

</pre>

Here, Anim is set to None, so the animation will instead come from the onion's animations, and AnimData being set to 4 (counting from 0) will have the onion perform the fifth animation in the onion's <code>animmgr.txt</code>, which is <code>bootup.bck.</code><br>

MovieTranslation defines how translation will be applied to the actor (string):

* "None" wont do anything,
* "Direct" will directly copy the translation to the actor position,
* "MinY" will directly copy the X and Z translations to the actor position, but set the Y position to the map's minimum Y,
* "FaceDir" will directly copy the translation to the actor position and copy the RotationY variable to the direction the actor is facing,
* "MoviePos" will copy the movie position to the actor position.

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*theLouie",
"Commands": [
"VAR Translation Index 16 17 18",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 3",
"WAIT 70",
"VAR Translation Index 19 20 21",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 4",
"WAIT 350",
]
},</pre>
Here, our actor is <code>*theLouie</code> (Louie), the first set of translation (in this case, movement of Louie's model) coordinates come from the value groups at indexes 16, 17, 18 (counting from 0) in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fourth (0, 1, 2, 3) file in the archive as the animation.
<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage1.png
</gallery>
After waiting 70 frames (and after the textbox is cleared) the second set of translation coordinates come from the value groups at indexes 19, 20, 21 in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fifth (0, 1, 2, 3, 4) file in the archive as the animation.<br>

Translation coordinates can be obtained the same way as obtaining camera position coordinates. <br>

Onions (including the ship and pod), navis, underground cave holes, and geysers also have their own special properties that serve as commands that can be set. <br>

(note: the format for these identifiers is hex value/JSON name)<br>

Onions<br>

* 0x64/CreateHead1 - create sprout
* 0x65/Spot - starts onion/ship/pod spot effect
* 0x66/SpotState - stops onion/ship/pod spot effect
* 0x67/StartPropera - start ship propeller animation
* 0x68/StopPropera - stop ship propeller animation
* 0x69/CreateHead2 - create sprout

Navi <br>

* 0x64/EnterPikis - make Pikmin go into the onion/ship
* 0x66/HoleInPikis - make Pikmin go into a cave hole
* 0x67/FountainPikis - make Pikmin jump onto a geyser
* 0x68/DelShadow - hide leader shadow
* 0x69/DelParticles - hide leader particles
* 0x6a/AddParticles - show leader particles
* 0x6b/AddShadow - show leader shadow

Hole<br>

* 0x64 - make hole appear

Geyser

* 0x64 - make geyser appear

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"WAIT 105",
"SET CreateHead2",
"WAIT 315",
]
},</pre>

<h3>Particle Actors</h3>

Particle Actors are particles, getting their data from the <code>efx.jpc</code> included in the cutscene archive.

Particle actors have two properties:

* Parc - the particle ID (Short) and the particle list index (Byte) in the JPC.
* Targ - the object on which the particle will appear. If a second string is specified, the particle will appear on the object's model joint specified by the second string

Example:

<pre>"JACT": {
"Type": "@boot_gr_b",
"Commands": [
"SET Parc 5 5",
"SET Targ *onyon_R",
"WAIT 390",
]
},
"JACT": {
"Type": "@boot_gr_o",
"Commands": [
"SET Parc 6 5",
"SET Targ *onyon_R body_1",
"WAIT 390",
]
},</pre>

Particles have three variables:<br>

* Translation - XYZ position offset from the position of the object it is attached to, or the cutscene position if not attached to an object.(float)
* Rotation - XYZ rotation relative to the particle's default orientation(float)
* Scaling - XYZ size relative to the particle's default size(float)

If "ground" is the second string, the particle will uses the object position and ignore the object matrix.

<h3>Special Actors</h3>

Special Actors are actors that can affect parts of the game and execute special commands. They are usually context sensitive.<br>

The properties (commands) are:<br>

* 0x00/LeaveCave - abandon treasures and pikmin when giving up
* 0x01/DayEnd - create day end enemies, spawn left behind Pikmin
* 0x02/FallPikiSound - start falling Pikmin sound effects in cave entry
* 0x03/ForceEnterPiki - force Pikmin into the Onion on day 1
* 0x65/StartDemoCamera - start "demo" camera type (using the regular game camera instead of the cutscene camera)
* 0x66/EndDemoCamera - go back to normal player camera
* 0xC9/OpenKentei - open treasure collection UI (res_kantei)
* 0xCB/OpenKentei - open treasure collection UI (res_kantei)
* 0x12D/FadeOut - fade the screen
* 0x12E/FadeIn - unfade the screen

Example:
<pre>"JACT": {
"Type": "+MovieCommand",
"Commands": [
"SET FallPikiSound",
"WAIT 219",
]
},</pre>

When the StartDemoCamera command is used, the cutscene will use the game's camera rather than the cutscene camera. This is mainly seen in <code>s03_orimadown</code>.

<h3>Actors</h3>

Actors are regular models that can appear in a cutscene.

Actor properties are:

* BCKIdx - sets the index of the BCK data in the cutscene archive that will be applied to the actor it's set to affect. (int)
* BMDIdx - sets the index of the BMD model the actor will use. (int)

Actor variables are

* Translation - the XYZ actor position offset from the movie position. (float)
* Scaling - the XYZ actor size relative to its default model size. (float)
* Rotation - the XYZ actor rotation relative to its default orientation. (float)<br>

Now that we've absorbed all that, let's add some actors to our cutscene.<br>

We're going to add Olimar, and have him play the down animation from <code>s03_orimadown</code>. We'll keep him stationary.

<pre>"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},</pre>

Note: because we don't have any translation going on here, olimar will be spawned where he would be spawned in regular gameplay.

<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage2.png
</gallery>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Actortutorialimage3.png
</gallery>

<h1>Sounds and messages</h1>

Message blocks are usually paired with a control block, presumably to halt things until the text box is done.<br>

<pre>"JMSG": {
"Type": "メッセージ",
"Commands": [
"WAIT 88",
"SET Code 894 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "コントロール",
"Commands": [
"WAIT 89",
"SYNC 1",
"WAIT 1",
]
},</pre>
The Type for messages is always "メッセージ" ("message"), and the Type for control is always "コントロール" ("control"). If there is more than one message/control in a cutscene, a number will follow the text (e.g. "メッセージ２" for the second message). Note that these aren't required, and currently, replacing the japanese text with english is needed for the rebuilding to not make a malformed STB.
Note the Code being set for the message block. The first three digits (short) are the message index (in decimal) in the [[BMG_file|BMG]]. The last digit (short) is the sub index of the message.

Sounds have two major components: Music, which is handled outside the STB, and sound effects, which for the most part are handled inside the STB.<br>

It's still worth mentioning some things about music:<br>

Which AST that is associated with which cutscene is controlled by <code>PSM::Demo::initiate</code> (in utilityU/PSMainSide_Demo.cpp) in the game's code. The function checks for a cutscene's name, then associates a stream file ID with it.

In vanilla, two cutscenes (<code>x20_blackman</code> and <code>x03_find_red_onyon</code>) are coded not to start with music initially. For the latter cutscene, audio is coded to start after the first text box has been closed.

Now about the other part of cutscene audio: Sound effects.<br>
This is what a typical sound block looks like:
<pre>"JSND": {
"Type": "#orimaAlive_2_1",
"Commands": [
"WAIT 335",
"SET Parent *orimaAlive_2",
"SET ParentNode happajnt3",
"SET ParentEnable True",
"SET Located True",
"SET ID 2161",
"SET BeginFadeIn 0.0",
"WAIT 12",
]
},</pre>

As stated earlier, a <code>#</code> in front of the name of the actor denotes a sound. <br>

Sound's properties are:

* Parent - binds the sound to an actor (in this case, the second alive player, or Louie) (string)
* ParentNode - further binds the sound to a specific joint on the model of the actor (string)
* ParentEnable - sets this binding to true. (boolean)
* Located - tells the sound to follow a position, whether from an attached creature or a direct position variable. (boolean)
* ID - the sound effect ID, in decimal. See [https://pikmintkb.com/wiki/Se.bms this page] for IDs. (int)
* Begin - starts the sound.
* BeginFadeIn - tells the sound to fade in when started, with the time it takes to fade in determined by the float after it.
* End - stops the sound.
* EndFadeOut - tells the sound to fade out when started, with the time it takes to fade out determined by the float after it.

Sound's variables are:

* Volume (float)
* Pan (float)
* Pitch (float)
* TempoProportion (float) - speed
* Fxmix (float) - reverb/echo
* Position (float) - XYZ sound position offset from the movie position

Let's add a sound effect and a text box to our cutscene. <br>

Text box first, we'll use message index 915 (in the BMG, this will show as hex, so it's actually 0x393) and have it appear at the end of the cutscene.

<pre>"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},</pre>

Due to a seemingly hardware dependent bug, the stb created by STB2JSON may have the "control block" represented as <code>0xEFBFBDEFBFBDEFBFBDEFBFBD</code> instead of <code>0xFFFFFFFF</code>, which is the correct one. If this happens, open your stb in a hex editor and change the offending bytes, making sure to delete the extra bytes.
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage1.png
</gallery>
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage2.png
</gallery>
Now let's test in game. <br>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Messagetutorialimage3.png
</gallery>

Finally, let's add a sound. Let's play <code>PSSE_SY_WMAP_MONEY_UP</code> (one of the ka-ching sounds)
We're not going to tie it to any actor, just have it play on its own.

<pre>"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},</pre>

Our whole JSON should now look like this:
<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},
"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},
"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},
}
</pre>
Convert your JSON to STB, remember to fix the control block if needed, repack your archive with WiiExplorer (make sure the file IDs are correct!), and play the cutscene in game.<br>

Congratulations, you have now made a full cutscene! Feel free to experiment with editing vanilla cutscenes, or making more of your own.

Cutscene Editing and Creation

2025-06-04T15:02:28Z

Iwillremembermypasswordthistime: particle correction

This page will run through editing and creating your own cutscenes in Pikmin 2. <br>
Cutscenes use the JStudio library, which was used in Wind Waker, Twilight Princess, Pikmin 2, and Skyward Sword.<br>
In Pikmin 2, cutscenes are contained in <code>demo.szs</code> files in <code>user/Mukki/movie</code>.<br>
Inside these szs files are a few assets, most notably the JStudio Binary (STB) file. This file controls initialization of cutscene data, as well as camera instructions.<br>
We can use a program called [https://drive.google.com/file/d/1JNqFF1IuJgdwzNA3XvVUEapyCwc2xfvP STB2JSON] to convert this to a more readable format.<br>

Note when extracting cutscene archives, you must use a program like WiiExplorer that can preserve the file indexes. This is because stb files load assets based in index, not by filename.<br>

<h1>STB Basics</h1>

STB files are separated into different "blocks" that can represent different "objects". The available blocks in the format are:

- JFVB (function value block)<br>
- JCMR (camera)<br>
- JABL (ambient light)<br>
- JACT (actor)<br>
- JSND (sound)<br>
- JLIT (light)<br>
- JCNT (control)<br>
- JMSG (message)<br>
- JFOG (fog)<br>
- JPTC (particle)<br>

Pikmin 2 only uses JFVB, JCMR, JCNT, JACT, JMSG, and JSND (which are the blocks that are going to be covered here), though the other blocks are supported. Particles are instead actors with a special identifier (an @ symbol in front of the name of the actor)

An object contains a list of "commands":

* "VAR" to bind a value/function to a variable
* "SET" to directly affect a properties of the bound object
* "WAIT" to halt the execution of the object for a certain amount of frames
* "SYNC" to halt the execution of the object until an event, external to the STB, is fired
* "OFLG", "XFLG" and "AFLG" to OR/XOR/AND the stb flags with a value

Each object has a set of "variables", which are bound to a properties of the object. A value/function can be bound to a variable using the "VAR" command:

"VAR (VarName) (Value/function) (Data)",

The value/function types are:

Void, to write a 0 to the variable<br>
Immediate, to write a direct value to the variable (specified in (Data))<br>
Time, to write a direct value, that is multiplied by the number of frames since the last "WAIT" command multiplied by 0.03333333, to the variable (specified in (Data))<br>
Index, to attach a JFVB function to the variable (the function index is specified in (Data)).<br>

A variable can affect more than one value of the bound object, in this case, the (Data) field
will have more than 1 value.<br>
After the delay of a "WAIT" command has passed, ALL value/function will be unbound from the
variables.

An object's name is defined by the "Type" field.

The JFVB block is the only one that does not represent objects. Instead, it holds "functions" all that represent data and how it evolves over time. There are two main types of functions used: "Constant", which contains a value that never changes, and "Hermite", which contains a value that changes following Hermite interpolation.
This is where values such as animation translation data and camera coordinates are stored.

A group of values typically looks like this:
<pre>
{
"Func": "Hermite",
"Range": "0.0 12.966666",
"Data": [
[
"0.0",
"70.229546",
"0.0",
[
"12.966666",
"188.07487",
"0.0",
],
]
},</pre>

The range is typically the start and end frames of the movement, if the value is not a constant value. To convert between the time values in range and frames, divide the frame number by 0.03333333.<br>
in this example, 12.966666 becomes roughly frame 389. To convert frames to time, multiply by 0.03333333.

Each subgroup of values has three floats. The first one is the time, the second is the value of whatever you're putting (camera coordinates, animation translation data, etc), and the third is the tangent value for the hermite interpolation. Setting tangent values to 0.0 will result in a smooth ease.

<h1>Camera</h1>

Note when getting camera coordinates, the position coordinates and target coordinates will be relative to the origin of the cutscene's location (wherever it is activated). The origin of a cutscene is specified in <code>user/Mukki/movie/demo.txt</code>, and that value will need to be accounted for when getting coordinate values. <br>
For this example, we will be using a cutscene with an origin of <code>0.0, 0.0, 0.0</code>, and we will use the pikmin 2 gen editor to get coordinates, where values will be relative to <code>0.0, 0.0, 0.0</code> of the map's origin (which will serve as our cutscene origin).
Let's start making our stb. It's a good idea to start by getting a vanilla stb, and converting it to json, then editing our own values in.<br>
First, we're just doing camera, so delete everything aside from the JFVB and JCMR blocks.

To setup our camera block, input this information:

<pre>"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},</pre>

Setting the Type to "camera" will set the camera.<br>

Camera variables are:<br>

* ProjFovy - the field of view (FOV) of the camera. (float)
* ViewRoll - the rotation of the camera. (float)
* ViewPos - the XYZ position of the camera in the world. (float)
* TargPos - the XYZ position of where the camera is looking in the world. (float)
* Distance - the culling distance of the camera. It is usually set to <code>1.0 12800.0</code> (near distance, far distance) (float)

The indexes here correspond to values in the function value block. For instance, TargPos index 7 will have the Z coordinate of where the camera is looking take the values from the eighth group in the JFVB block.<br>
The index counts from 0.

Let's start setting some values. Our first value (ProjFovy) will be the FOV of our camera. We want to keep it a constant value, so well have our first FVB group look like this:
<pre>
{ (this is the bracket for the start of our JSON)
"JFVB": { (this is the bracket for the start of the JFVB block)
"Values": [ (this is the bracket for the start of all data values in the block)
{
"Func": "Constant",
"Data": "45.0",
},</pre>

Our next group will be rotation values. As before, we want to keep this constant.
<pre>
{
"Func": "Constant",
"Data": "0.0",
},</pre>

Our JSON should now look like this:
<pre>
{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},

}</pre>

Now it's time to get position coordinates from the gen editor. Open up the files for the valley of Repose, as that is the location of where our cutscene is.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage1.png
</gallery>
Place a reference object for the first set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage2.png
</gallery>
Copy the XYZ coordinates of the object into the JSON. They should be in the third (X), fourth (Y), and fifth (Z) set of values as Hermite functions. <br>
The first time value should be 0.0, for the start of the cutscene. Make sure the range is from frames 0 to 565 (converted to time).
<pre>
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
]
},</pre>

Place a reference object for the second set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage3.png
</gallery>
Copy the XYZ coordinates of the second object into the JSON as the second set in the value groups.
The time value should be 18.83333145 (frame 565), for the end of the cutscene.
<pre>{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},</pre>
Now for the target coordinates. It helps to move your position in the gen editor to one of your position reference objects, to get a betteer view of where you want your camera to look.<br>
Place a reference object for your target coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage4.png
</gallery>
We'll use a Constant function for the target, since we currently do not want where the camera is looking to change.
Copy the XYZ coordinates of the object into the JSON. They should be in the sixth (X), seventh (Y), and eighth (Z) set of values.<br>

<pre>{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
](this is the bracket for the end of all data values in the block)
},(this is the bracket for the end of the JFVB block)</pre>

This is what your JSON should look like now:

<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
}</pre>

Now you can save your JSON, use STB2JSON to convert it to STB, then repack the cutscene archive.
If everything was done correctly, it should look like this ingame:
<gallery mode="packed-hover" widths=400px heights=400px>
File:cutscene1.gif
</gallery>

<h1>Actors (and particles)</h1>

Actors are the most complicated part of cutscenes, so we'll need to break a few things down. <br>

There are four main types of actors:

Game Actors, which are certain creatures in the game world (like navis and onions). These are denoted with a <code>*</code> symbol in front of the actor's name. <br>
Special Actors, which are actors that can activate certain commands. These are denoted with a <code>+</code> symbol in front of the actor's name. <br>
Particle Actors, which are particles. These are denoted with a <code>@</code> symbol in front of the actor's name. <br>
Actors, which are regular models placed in a cutscene. These are denoted with a <code>p</code> symbol in front of the actor's name, though this doesn't seem to be required. <br>

Sound effects are not part of the JACT block, but behave similarly to actors. These are denoted with a <code>#</code> symbol in front of the actor's name.

<h3>Game Actors</h3>

For Game Actors, each one has an identifier:

* <code>"theOrima"</code> is Olimar.
* <code>"theLouie"</code> is Louie/President.
* <code>"orimaAlive_1"</code> is the first alive leader.
* <code>"orimaAlive_2"</code> is the second alive leader.
* <code>"orimaDead_1"</code> is the first dead leader.
* <code>"orimaDead_2"</code> is the second dead leader.
* <code>"onyon_R"</code> is the Red Onion.
* <code>"onyon_Y"</code> is the Yellow Onion.
* <code>"onyon_B"</code> is the Blue Onion.
* <code>"ufo"</code> is the Hocotate Ship.
* <code>"pod"</code> is the Research Pod.
* <code>"pikmin"</code> is the target of the cutscene, if that target is a Pikmin.
* <code>"orima"</code> or "player" is the current active player.
* <code>"target</code>" is the target of the cutscene.

Game Actor variables are:

* Translation - the XYZ actor position offset from the movie position. (float)
* RotationY - the Y rotation of the actor (float)

Game Actor properties are:

* AnimData
* Anim
* MovieTranslation

AnimData sets the index of the BCK data in the cutscene archive that will be applied to the creature it's set to affect. (int)
Anim sets which animation will be used. Setting Anim to "BCK" will use the BCK, while setting it to "None" will use the creature's base animation archive. (string)

Here's an example from the unused red onion boot cutscene:
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"SET MovieTranslation None",
"SET Anim None",
"SET AnimData 4",

</pre>

Here, Anim is set to None, so the animation will instead come from the onion's animations, and AnimData being set to 4 (counting from 0) will have the onion perform the fifth animation in the onion's <code>animmgr.txt</code>, which is <code>bootup.bck.</code><br>

MovieTranslation defines how translation will be applied to the actor (string):

* "None" wont do anything,
* "Direct" will directly copy the translation to the actor position,
* "MinY" will directly copy the X and Z translations to the actor position, but set the Y position to the map's minimum Y,
* "FaceDir" will directly copy the translation to the actor position and copy the RotationY variable to the direction the actor is facing,
* "MoviePos" will copy the movie position to the actor position.

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*theLouie",
"Commands": [
"VAR Translation Index 16 17 18",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 3",
"WAIT 70",
"VAR Translation Index 19 20 21",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 4",
"WAIT 350",
]
},</pre>
Here, our actor is <code>*theLouie</code> (Louie), the first set of translation (in this case, movement of Louie's model) coordinates come from the value groups at indexes 16, 17, 18 (counting from 0) in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fourth (0, 1, 2, 3) file in the archive as the animation.
<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage1.png
</gallery>
After waiting 70 frames (and after the textbox is cleared) the second set of translation coordinates come from the value groups at indexes 19, 20, 21 in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fifth (0, 1, 2, 3, 4) file in the archive as the animation.<br>

Translation coordinates can be obtained the same way as obtaining camera position coordinates. <br>

Onions (including the ship and pod), navis, underground cave holes, and geysers also have their own special properties that serve as commands that can be set. <br>

(note: the format for these identifiers is hex value/JSON name)<br>

Onions<br>

* 0x64/CreateHead1 - create sprout
* 0x65/Spot - starts onion/ship/pod spot effect
* 0x66/SpotState - stops onion/ship/pod spot effect
* 0x67/StartPropera - start ship propeller animation
* 0x68/StopPropera - stop ship propeller animation
* 0x69/CreateHead2 - create sprout

Navi <br>

* 0x64/EnterPikis - make Pikmin go into the onion/ship
* 0x66/HoleInPikis - make Pikmin go into a cave hole
* 0x67/FountainPikis - make Pikmin jump onto a geyser
* 0x68/DelShadow - hide leader shadow
* 0x69/DelParticles - hide leader particles
* 0x6a/AddParticles - show leader particles
* 0x6b/AddShadow - show leader shadow

Hole<br>

* 0x64 - make hole appear

Geyser

* 0x64 - make geyser appear

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"WAIT 105",
"SET CreateHead2",
"WAIT 315",
]
},</pre>

<h3>Particle Actors</h3>

Particle Actors are particles, getting their data from the <code>efx.jpc</code> included in the cutscene archive.

Particle actors have two properties:

* Parc - the particle ID (Short) and the particle list index (Byte) in the JPC.
* Targ - the object on which the particle will appear. If a second string is specified, the particle will appear on the object's model joint specified by the second string

Example:

<pre>"JACT": {
"Type": "@boot_gr_b",
"Commands": [
"SET Parc 5 5",
"SET Targ *onyon_R",
"WAIT 390",
]
},
"JACT": {
"Type": "@boot_gr_o",
"Commands": [
"SET Parc 6 5",
"SET Targ *onyon_R body_1",
"WAIT 390",
]
},</pre>

Particles have three variables:<br>

* Translation - XYZ position offset from the position of the object it is attached to, or the cutscene position if not attached to an object.(float)
* Rotation - XYZ rotation relative to the particle's default orientation(float)
* Scaling - XYZ size relative to the particle's default size(float)

If "ground" is the second string, the particle will uses the object position and ignore the object matrix.

<h3>Special Actors</h3>

Special Actors are actors that can affect parts of the game and execute special commands. They are usually context sensitive.<br>

The properties (commands) are:<br>

* 0x00/LeaveCave - abandon treasures and pikmin when giving up
* 0x01/DayEnd - create day end enemies, spawn left behind Pikmin
* 0x02/FallPikiSound - start falling Pikmin sound effects in cave entry
* 0x03/ForceEnterPiki - force Pikmin into the Onion on day 1
* 0x65/StartDemoCamera - start "demo" camera type (using the regular game camera instead of the cutscene camera)
* 0x66/EndDemoCamera - go back to normal player camera
* 0xC9/OpenKentei - open treasure collection UI (res_kantei)
* 0xCB/OpenKentei - open treasure collection UI (res_kantei)
* 0x12D/FadeOut - fade the screen
* 0x12E/FadeIn - unfade the screen

Example:
<pre>"JACT": {
"Type": "+MovieCommand",
"Commands": [
"SET FallPikiSound",
"WAIT 219",
]
},</pre>

When the StartDemoCamera command is used, the cutscene will use the game's camera rather than the cutscene camera. This is mainly seen in <code>s03_orimadown</code>.

<h3>Actors</h3>

Actors are regular models that can appear in a cutscene.

Actor properties are:

* BCKIdx - sets the index of the BCK data in the cutscene archive that will be applied to the actor it's set to affect. (int)
* BMDIdx - sets the index of the BMD model the actor will use. (int)

Actor variables are

* Translation - the XYZ actor position offset from the movie position. (float)
* Scaling - the XYZ actor size relative to its default model size. (float)
* Rotation - the XYZ actor rotation relative to its default orientation. (float)<br>

Now that we've absorbed all that, let's add some actors to our cutscene.<br>

We're going to add Olimar, and have him play the down animation from <code>s03_orimadown</code>. We'll keep him stationary.

<pre>"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},</pre>

Note: because we don't have any translation going on here, olimar will be spawned where he would be spawned in regular gameplay.

<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage2.png
</gallery>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Actortutorialimage3.png
</gallery>

<h1>Sounds and messages</h1>

Message blocks are usually paired with a control block, presumably to halt things until the text box is done.<br>

<pre>"JMSG": {
"Type": "メッセージ",
"Commands": [
"WAIT 88",
"SET Code 894 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "コントロール",
"Commands": [
"WAIT 89",
"SYNC 1",
"WAIT 1",
]
},</pre>
The Type for messages is always "メッセージ" ("message"), and the Type for control is always "コントロール" ("control"). If there is more than one message/control in a cutscene, a number will follow the text (e.g. "メッセージ２" for the second message). Note that these aren't required, and currently, replacing the japanese text with english is needed for the rebuilding to not make a malformed STB.
Note the Code being set for the message block. The first three digits (short) are the message index (in decimal) in the [[BMG_file|BMG]]. The last digit (short) is the sub index of the message.

Sounds have two major components: Music, which is handled outside the STB, and sound effects, which for the most part are handled inside the STB.<br>

It's still worth mentioning some things about music:<br>

Which AST that is associated with which cutscene is controlled by <code>PSM::Demo::initiate</code> (in utilityU/PSMainSide_Demo.cpp) in the game's code. The function checks for a cutscene's name, then associates a stream file ID with it.

In vanilla, two cutscenes (<code>x20_blackman</code> and <code>x03_find_red_onyon</code>) are coded not to start with music initially. For the latter cutscene, audio is coded to start after the first text box has been closed.

Now about the other part of cutscene audio: Sound effects.<br>
This is what a typical sound block looks like:
<pre>"JSND": {
"Type": "#orimaAlive_2_1",
"Commands": [
"WAIT 335",
"SET Parent *orimaAlive_2",
"SET ParentNode happajnt3",
"SET ParentEnable True",
"SET Located True",
"SET ID 2161",
"SET BeginFadeIn 0.0",
"WAIT 12",
]
},</pre>

As stated earlier, a <code>#</code> in front of the name of the actor denotes a sound. <br>

Sound's properties are:

* Parent - binds the sound to an actor (in this case, the second alive player, or Louie) (string)
* ParentNode - further binds the sound to a specific joint on the model of the actor (string)
* ParentEnable - sets this binding to true. (boolean)
* Located - tells the sound to follow a position, whether from an attached creature or a direct position variable. (boolean)
* ID - the sound effect ID, in decimal. See [https://pikmintkb.com/wiki/Se.bms this page] for IDs. (int)
* Begin - starts the sound.
* BeginFadeIn - tells the sound to fade in when started, with the time it takes to fade in determined by the float after it.
* End - stops the sound.
* EndFadeOut - tells the sound to fade out when started, with the time it takes to fade out determined by the float after it.

Sound's variables are:

* Volume (float)
* Pan (float)
* Pitch (float)
* TempoProportion (float) - speed
* Fxmix (float) - reverb/echo
* Position (float) - XYZ sound position offset from the movie position

Let's add a sound effect and a text box to our cutscene. <br>

Text box first, we'll use message index 915 (in the BMG, this will show as hex, so it's actually 0x393) and have it appear at the end of the cutscene.

<pre>"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},</pre>

Due to a seemingly hardware dependent bug, the stb created by STB2JSON may have the "control block" represented as <code>0xEFBFBDEFBFBDEFBFBDEFBFBD</code> instead of <code>0xFFFFFFFF</code>, which is the correct one. If this happens, open your stb in a hex editor and change the offending bytes, making sure to delete the extra bytes.
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage1.png
</gallery>
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage2.png
</gallery>
Now let's test in game. <br>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Messagetutorialimage3.png
</gallery>

Finally, let's add a sound. Let's play <code>PSSE_SY_WMAP_MONEY_UP</code> (one of the ka-ching sounds)
We're not going to tie it to any actor, just have it play on its own.

<pre>"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},</pre>

Our whole JSON should now look like this:
<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},
"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},
"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},
}
</pre>
Convert your JSON to STB, remember to fix the control block if needed, repack your archive with WiiExplorer (make sure the file IDs are correct!), and play the cutscene in game.<br>

Congratulations, you have now made a full cutscene! Feel free to experiment with editing vanilla cutscenes, or making more of your own.

BTK file

2025-05-28T20:38:19Z

Iwillremembermypasswordthistime: fix damn page

'''BTK''' stores texture matrix animation data.

=JSYSTEM header=

The file starts with a standard [[JSYSTEM#Header|JSYSTEM]] header, using a magic of J3D1btk1. BTK files have one chunk, the TTK1 chunk.

=TTK1 Chunk=

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || [[JSYSTEM#Chunk_Data|Chunk Header]] || Standard JSYSTEM chunk header
|-
| <center>0x08</center> || [[BCK#LoopMode|Loop Mode]] || Loop Mode ||
|-
| <center>0x09</center> || int || Rotation Frac || Multiplier for fixed-point decimal
|-
| <center>0x0A</center> || short || Duration || The number of frames in the animation
|-
| <center>0x0C</center> || short || Keyframe Count || The total number of keyframes, times 3
|-
| <center>0x0E</center> || short || Scale Table Count || The number of entries in the scale table
|-
| <center>0x10</center> || short || Rotation Table Count || The number of entries in the rotation table
|-
| <center>0x12</center> || short || Translation Table Count || The number of entries in the translation table
|-
| <center>0x14</center> || int || Animation Data Table Offset || Offset to the start of the animation data table
|-
| <center>0x18</center> || int || Remap Table Offset || Not used at runtime
|-
| <center>0x1C</center> || int || Name Table Offset || Contains the material names to bind against
|-
| <center>0x20</center> || int || Texture Coordinate Index Table Offset ||
|-
| <center>0x24</center> || int || Center Coordinate Table Offset ||
|-
| <center>0x28</center> || int || Scale Table Offset ||
|-
| <center>0x2C</center> || int || Rotation Table Offset ||
|-
| <center>0x30</center> || int || Translation Table Offset ||
|-
| <center>0x34</center> || byte[0x28] || Post Matrix Data || A similar set of tables, for Post Matrices. Has never been observed to exist in the wild.
|-
| <center>0x5C</center> || MatrixMode || Matrix Mode || Determines whether texture coordinates should be calculated with the Basic or Maya algorithm.
|-
|}

==MatrixMode==

MatrixMode is an enum as follows:

{| class="wikitable"
|-
! Value !! Name || Meaning
|-
| 0x00000000 || Basic Mode ||
|-
| 0x00000001 || Maya Mode ||
|}

The table data is packed in Struct-of-Arrays fashion, meaning that to read the Nth animation, one should read the Nth item in the material name, texture coordinate index, material center, and animation data tables.

==Material Name and Texture Coordinate Index==

The material name and texture coordinate index tell you how to bind the animation to a model. Animations are always bound by material name and texture coordinate index. The material name table is a [[JSYSTEM#Name_Tables|JUTNameTab]] table. The table entries are laid out as follows:

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || GXTexCoordID (byte) || Texture Coordinate Index ||
|}

==Center Coordinate Table==

The center coordinate is used by the Basic Matrix Mode algorithm. The table entries are laid out as follows:

{| class="wikitable"
|-
! Offset !! Type !! Name !! Description
|-
| <center>0x00</center> || float || S ||
|-
| <center>0x04</center> || float || T ||
|-
| <center>0x08</center> || float || Q ||
|}

== Animation Data ==

The animation data itself is stored in an identical form to BCK, so see the [[BCK page|BCK]] for details. Note that as this is acting on texture coordinates rather than world positions, the coordinates S, T, Q are used instead of X, Y, Z.

== Calculating the SRT Texture Matrix ==

The SRT texture matrix can be calculated by either the Basic or Maya matrix modes.

=== Basic Mode ===

The Center S, Center T, Scale S, Scale T, Rotation Q, Translation S and Translation T inputs are used. The final matrix is a 3x2 matrix, which is as follows:

00 = Scale S * cos(Rotation Q)
01 = Scale S * -sin(Rotation Q)
02 = Translation S + Center S + (Scale S * (sin(Rotation Q) * Center T - cos(Rotation Q) * Center S))

10 = Scale T * sin(Rotation Q)
11 = Scale T * cos(Rotation R)
12 = Translation T + Center T + (Scale T * (-sin(Rotation Q) * Center S + cos(Rotation Q) * Center T))

=== Maya Mode ===

The Scale S, Scale T, Rotation Q, Translation S and Translation T inputs are used. The final matrix is a 3x2 matrix, which is as follows:

00 = Scale S * cos(Rotation Q)
01 = Scale T * -sin(Rotation Q)
02 = Scale S * ((0.5 * -cos(Rotation Q)) - (0.5 * sin(Rotation Q) - 0.5) - Translation S)

10 = Scale S * sin(rotation)
11 = Scale T * cos(rotation)
12 = Scale T * ((0.5 * -cos(Rotation Q)) + (0.5 * sin(Rotation Q) - 0.5) + Translation T) + 1

{{credits|cloudmodding}}

Cutscene Editing and Creation

2025-05-21T05:37:24Z

Iwillremembermypasswordthistime: apparently cutscenes can use the other blocks?

This page will run through editing and creating your own cutscenes in Pikmin 2. <br>
Cutscenes use the JStudio library, which was used in Wind Waker, Twilight Princess, Pikmin 2, and Skyward Sword.<br>
In Pikmin 2, cutscenes are contained in <code>demo.szs</code> files in <code>user/Mukki/movie</code>.<br>
Inside these szs files are a few assets, most notably the JStudio Binary (STB) file. This file controls initialization of cutscene data, as well as camera instructions.<br>
We can use a program called [https://drive.google.com/file/d/1JNqFF1IuJgdwzNA3XvVUEapyCwc2xfvP STB2JSON] to convert this to a more readable format.<br>

Note when extracting cutscene archives, you must use a program like WiiExplorer that can preserve the file indexes. This is because stb files load assets based in index, not by filename.<br>

<h1>STB Basics</h1>

STB files are separated into different "blocks" that can represent different "objects". The available blocks in the format are:

- JFVB (function value block)<br>
- JCMR (camera)<br>
- JABL (ambient light)<br>
- JACT (actor)<br>
- JSND (sound)<br>
- JLIT (light)<br>
- JCNT (control)<br>
- JMSG (message)<br>
- JFOG (fog)<br>
- JPTC (particle)<br>

Pikmin 2 only uses JFVB, JCMR, JCNT, JACT, JMSG, and JSND (which are the blocks that are going to be covered here), though the other blocks are supported. Particles are instead actors with a special identifier (an @ symbol in front of the name of the actor)

An object contains a list of "commands":

* "VAR" to bind a value/function to a variable
* "SET" to directly affect a properties of the bound object
* "WAIT" to halt the execution of the object for a certain amount of frames
* "SYNC" to halt the execution of the object until an event, external to the STB, is fired
* "OFLG", "XFLG" and "AFLG" to OR/XOR/AND the stb flags with a value

Each object has a set of "variables", which are bound to a properties of the object. A value/function can be bound to a variable using the "VAR" command:

"VAR (VarName) (Value/function) (Data)",

The value/function types are:

Void, to write a 0 to the variable<br>
Immediate, to write a direct value to the variable (specified in (Data))<br>
Time, to write a direct value, that is multiplied by the number of frames since the last "WAIT" command multiplied by 0.03333333, to the variable (specified in (Data))<br>
Index, to attach a JFVB function to the variable (the function index is specified in (Data)).<br>

A variable can affect more than one value of the bound object, in this case, the (Data) field
will have more than 1 value.<br>
After the delay of a "WAIT" command has passed, ALL value/function will be unbound from the
variables.

An object's name is defined by the "Type" field.

The JFVB block is the only one that does not represent objects. Instead, it holds "functions" all that represent data and how it evolves over time. There are two main types of functions used: "Constant", which contains a value that never changes, and "Hermite", which contains a value that changes following Hermite interpolation.
This is where values such as animation translation data and camera coordinates are stored.

A group of values typically looks like this:
<pre>
{
"Func": "Hermite",
"Range": "0.0 12.966666",
"Data": [
[
"0.0",
"70.229546",
"0.0",
[
"12.966666",
"188.07487",
"0.0",
],
]
},</pre>

The range is typically the start and end frames of the movement, if the value is not a constant value. To convert between the time values in range and frames, divide the frame number by 0.03333333.<br>
in this example, 12.966666 becomes roughly frame 389. To convert frames to time, multiply by 0.03333333.

Each subgroup of values has three floats. The first one is the time, the second is the value of whatever you're putting (camera coordinates, animation translation data, etc), and the third is the tangent value for the hermite interpolation. Setting tangent values to 0.0 will result in a smooth ease.

<h1>Camera</h1>

Note when getting camera coordinates, the position coordinates and target coordinates will be relative to the origin of the cutscene's location (wherever it is activated). The origin of a cutscene is specified in <code>user/Mukki/movie/demo.txt</code>, and that value will need to be accounted for when getting coordinate values. <br>
For this example, we will be using a cutscene with an origin of <code>0.0, 0.0, 0.0</code>, and we will use the pikmin 2 gen editor to get coordinates, where values will be relative to <code>0.0, 0.0, 0.0</code> of the map's origin (which will serve as our cutscene origin).
Let's start making our stb. It's a good idea to start by getting a vanilla stb, and converting it to json, then editing our own values in.<br>
First, we're just doing camera, so delete everything aside from the JFVB and JCMR blocks.

To setup our camera block, input this information:

<pre>"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},</pre>

Setting the Type to "camera" will set the camera.<br>

Camera variables are:<br>

* ProjFovy - the field of view (FOV) of the camera. (float)
* ViewRoll - the rotation of the camera. (float)
* ViewPos - the XYZ position of the camera in the world. (float)
* TargPos - the XYZ position of where the camera is looking in the world. (float)
* Distance - the culling distance of the camera. It is usually set to <code>1.0 12800.0</code> (near distance, far distance) (float)

The indexes here correspond to values in the function value block. For instance, TargPos index 7 will have the Z coordinate of where the camera is looking take the values from the eighth group in the JFVB block.<br>
The index counts from 0.

Let's start setting some values. Our first value (ProjFovy) will be the FOV of our camera. We want to keep it a constant value, so well have our first FVB group look like this:
<pre>
{ (this is the bracket for the start of our JSON)
"JFVB": { (this is the bracket for the start of the JFVB block)
"Values": [ (this is the bracket for the start of all data values in the block)
{
"Func": "Constant",
"Data": "45.0",
},</pre>

Our next group will be rotation values. As before, we want to keep this constant.
<pre>
{
"Func": "Constant",
"Data": "0.0",
},</pre>

Our JSON should now look like this:
<pre>
{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},

}</pre>

Now it's time to get position coordinates from the gen editor. Open up the files for the valley of Repose, as that is the location of where our cutscene is.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage1.png
</gallery>
Place a reference object for the first set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage2.png
</gallery>
Copy the XYZ coordinates of the object into the JSON. They should be in the third (X), fourth (Y), and fifth (Z) set of values as Hermite functions. <br>
The first time value should be 0.0, for the start of the cutscene. Make sure the range is from frames 0 to 565 (converted to time).
<pre>
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
]
},</pre>

Place a reference object for the second set of coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage3.png
</gallery>
Copy the XYZ coordinates of the second object into the JSON as the second set in the value groups.
The time value should be 18.83333145 (frame 565), for the end of the cutscene.
<pre>{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},</pre>
Now for the target coordinates. It helps to move your position in the gen editor to one of your position reference objects, to get a betteer view of where you want your camera to look.<br>
Place a reference object for your target coordinates.
<gallery mode="packed-hover" widths=400px heights=400px>
File:Cutscenetutorialimage4.png
</gallery>
We'll use a Constant function for the target, since we currently do not want where the camera is looking to change.
Copy the XYZ coordinates of the object into the JSON. They should be in the sixth (X), seventh (Y), and eighth (Z) set of values.<br>

<pre>{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
](this is the bracket for the end of all data values in the block)
},(this is the bracket for the end of the JFVB block)</pre>

This is what your JSON should look like now:

<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
}</pre>

Now you can save your JSON, use STB2JSON to convert it to STB, then repack the cutscene archive.
If everything was done correctly, it should look like this ingame:
<gallery mode="packed-hover" widths=400px heights=400px>
File:cutscene1.gif
</gallery>

<h1>Actors (and particles)</h1>

Actors are the most complicated part of cutscenes, so we'll need to break a few things down. <br>

There are four main types of actors:

Game Actors, which are certain creatures in the game world (like navis and onions). These are denoted with a <code>*</code> symbol in front of the actor's name. <br>
Special Actors, which are actors that can activate certain commands. These are denoted with a <code>+</code> symbol in front of the actor's name. <br>
Particle Actors, which are particles. These are denoted with a <code>@</code> symbol in front of the actor's name. <br>
Actors, which are regular models placed in a cutscene. These are denoted with a <code>p</code> symbol in front of the actor's name, though this doesn't seem to be required. <br>

Sound effects are not part of the JACT block, but behave similarly to actors. These are denoted with a <code>#</code> symbol in front of the actor's name.

<h3>Game Actors</h3>

For Game Actors, each one has an identifier:

* <code>"theOrima"</code> is Olimar.
* <code>"theLouie"</code> is Louie/President.
* <code>"orimaAlive_1"</code> is the first alive leader.
* <code>"orimaAlive_2"</code> is the second alive leader.
* <code>"orimaDead_1"</code> is the first dead leader.
* <code>"orimaDead_2"</code> is the second dead leader.
* <code>"onyon_R"</code> is the Red Onion.
* <code>"onyon_Y"</code> is the Yellow Onion.
* <code>"onyon_B"</code> is the Blue Onion.
* <code>"ufo"</code> is the Hocotate Ship.
* <code>"pod"</code> is the Research Pod.
* <code>"pikmin"</code> is the target of the cutscene, if that target is a Pikmin.
* <code>"orima"</code> or "player" is the current active player.
* <code>"target</code>" is the target of the cutscene.

Game Actor variables are:

* Translation - the XYZ actor position offset from the movie position. (float)
* RotationY - the Y rotation of the actor (float)

Game Actor properties are:

* AnimData
* Anim
* MovieTranslation

AnimData sets the index of the BCK data in the cutscene archive that will be applied to the creature it's set to affect. (int)
Anim sets which animation will be used. Setting Anim to "BCK" will use the BCK, while setting it to "None" will use the creature's base animation archive. (string)

Here's an example from the unused red onion boot cutscene:
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"SET MovieTranslation None",
"SET Anim None",
"SET AnimData 4",

</pre>

Here, Anim is set to None, so the animation will instead come from the onion's animations, and AnimData being set to 4 (counting from 0) will have the onion perform the fifth animation in the onion's <code>animmgr.txt</code>, which is <code>bootup.bck.</code><br>

MovieTranslation defines how translation will be applied to the actor (string):

* "None" wont do anything,
* "Direct" will directly copy the translation to the actor position,
* "MinY" will directly copy the X and Z translations to the actor position, but set the Y position to the map's minimum Y,
* "FaceDir" will directly copy the translation to the actor position and copy the RotationY variable to the direction the actor is facing,
* "MoviePos" will copy the movie position to the actor position.

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*theLouie",
"Commands": [
"VAR Translation Index 16 17 18",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 3",
"WAIT 70",
"VAR Translation Index 19 20 21",
"SET MovieTranslation Direct",
"SET Anim BCK",
"SET AnimData 4",
"WAIT 350",
]
},</pre>
Here, our actor is <code>*theLouie</code> (Louie), the first set of translation (in this case, movement of Louie's model) coordinates come from the value groups at indexes 16, 17, 18 (counting from 0) in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fourth (0, 1, 2, 3) file in the archive as the animation.
<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage1.png
</gallery>
After waiting 70 frames (and after the textbox is cleared) the second set of translation coordinates come from the value groups at indexes 19, 20, 21 in the FVB block, the animation is set to pull from the cutscene archive, and it sets the fifth (0, 1, 2, 3, 4) file in the archive as the animation.<br>

Translation coordinates can be obtained the same way as obtaining camera position coordinates. <br>

Onions (including the ship and pod), navis, underground cave holes, and geysers also have their own special properties that serve as commands that can be set. <br>

(note: the format for these identifiers is hex value/JSON name)<br>

Onions<br>

* 0x64/CreateHead1 - create sprout
* 0x65/Spot - starts onion/ship/pod spot effect
* 0x66/SpotState - stops onion/ship/pod spot effect
* 0x67/StartPropera - start ship propeller animation
* 0x68/StopPropera - stop ship propeller animation
* 0x69/CreateHead2 - create sprout

Navi <br>

* 0x64/EnterPikis - make Pikmin go into the onion/ship
* 0x66/HoleInPikis - make Pikmin go into a cave hole
* 0x67/FountainPikis - make Pikmin jump onto a geyser
* 0x68/DelShadow - hide leader shadow
* 0x69/DelParticles - hide leader particles
* 0x6a/AddParticles - show leader particles
* 0x6b/AddShadow - show leader shadow

Hole<br>

* 0x64 - make hole appear

Geyser

* 0x64 - make geyser appear

Example (from <code>x03_find_red_onyon</code>)
<pre>"JACT": {
"Type": "*onyon_R",
"Commands": [
"WAIT 105",
"SET CreateHead2",
"WAIT 315",
]
},</pre>

<h3>Particle Actors</h3>

Particle Actors are particles, getting their data from the <code>efx.jpc</code> included in the cutscene archive.

Particle actors have two properties:

* Parc - the particle ID (Short) and the particle list index (Byte) in the JPC.
* Targ - the object on which the particle will appear. If a second string is specified, the particle will appear on the object's model joint specified by the second string

Example:

<pre>"JACT": {
"Type": "@boot_gr_b",
"Commands": [
"SET Parc 5 5",
"SET Targ *onyon_R",
"WAIT 390",
]
},
"JACT": {
"Type": "@boot_gr_o",
"Commands": [
"SET Parc 6 5",
"SET Targ *onyon_R body_1",
"WAIT 390",
]
},</pre>

Particles have one variable:<br>

* Translation - XYZ position offset from the position of the object it is attached to(float)

If "ground" is the second string, the particle will uses the object position and ignore the object matrix.

<h3>Special Actors</h3>

Special Actors are actors that can affect parts of the game and execute special commands. They are usually context sensitive.<br>

The properties (commands) are:<br>

* 0x00/LeaveCave - abandon treasures and pikmin when giving up
* 0x01/DayEnd - create day end enemies, spawn left behind Pikmin
* 0x02/FallPikiSound - start falling Pikmin sound effects in cave entry
* 0x03/ForceEnterPiki - force Pikmin into the Onion on day 1
* 0x65/StartDemoCamera - start "demo" camera type (using the regular game camera instead of the cutscene camera)
* 0x66/EndDemoCamera - go back to normal player camera
* 0xC9/OpenKentei - open treasure collection UI (res_kantei)
* 0xCB/OpenKentei - open treasure collection UI (res_kantei)
* 0x12D/FadeOut - fade the screen
* 0x12E/FadeIn - unfade the screen

Example:
<pre>"JACT": {
"Type": "+MovieCommand",
"Commands": [
"SET FallPikiSound",
"WAIT 219",
]
},</pre>

When the StartDemoCamera command is used, the cutscene will use the game's camera rather than the cutscene camera. This is mainly seen in <code>s03_orimadown</code>.

<h3>Actors</h3>

Actors are regular models that can appear in a cutscene.

Actor properties are:

* BCKIdx - sets the index of the BCK data in the cutscene archive that will be applied to the actor it's set to affect. (int)
* BMDIdx - sets the index of the BMD model the actor will use. (int)

Actor variables are

* Translation - the XYZ actor position offset from the movie position. (float)
* Scaling - the XYZ actor size relative to its default model size. (float)
* Rotation - the XYZ actor rotation relative to its default orientation. (float)<br>

Now that we've absorbed all that, let's add some actors to our cutscene.<br>

We're going to add Olimar, and have him play the down animation from <code>s03_orimadown</code>. We'll keep him stationary.

<pre>"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},</pre>

Note: because we don't have any translation going on here, olimar will be spawned where he would be spawned in regular gameplay.

<gallery mode="packed-hover" widths=100px heights=100px>
File:Actortutorialimage2.png
</gallery>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Actortutorialimage3.png
</gallery>

<h1>Sounds and messages</h1>

Message blocks are usually paired with a control block, presumably to halt things until the text box is done.<br>

<pre>"JMSG": {
"Type": "メッセージ",
"Commands": [
"WAIT 88",
"SET Code 894 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "コントロール",
"Commands": [
"WAIT 89",
"SYNC 1",
"WAIT 1",
]
},</pre>
The Type for messages is always "メッセージ" ("message"), and the Type for control is always "コントロール" ("control"). If there is more than one message/control in a cutscene, a number will follow the text (e.g. "メッセージ２" for the second message). Note that these aren't required, and currently, replacing the japanese text with english is needed for the rebuilding to not make a malformed STB.
Note the Code being set for the message block. The first three digits (short) are the message index (in decimal) in the [[BMG_file|BMG]]. The last digit (short) is the sub index of the message.

Sounds have two major components: Music, which is handled outside the STB, and sound effects, which for the most part are handled inside the STB.<br>

It's still worth mentioning some things about music:<br>

Which AST that is associated with which cutscene is controlled by <code>PSM::Demo::initiate</code> (in utilityU/PSMainSide_Demo.cpp) in the game's code. The function checks for a cutscene's name, then associates a stream file ID with it.

In vanilla, two cutscenes (<code>x20_blackman</code> and <code>x03_find_red_onyon</code>) are coded not to start with music initially. For the latter cutscene, audio is coded to start after the first text box has been closed.

Now about the other part of cutscene audio: Sound effects.<br>
This is what a typical sound block looks like:
<pre>"JSND": {
"Type": "#orimaAlive_2_1",
"Commands": [
"WAIT 335",
"SET Parent *orimaAlive_2",
"SET ParentNode happajnt3",
"SET ParentEnable True",
"SET Located True",
"SET ID 2161",
"SET BeginFadeIn 0.0",
"WAIT 12",
]
},</pre>

As stated earlier, a <code>#</code> in front of the name of the actor denotes a sound. <br>

Sound's properties are:

* Parent - binds the sound to an actor (in this case, the second alive player, or Louie) (string)
* ParentNode - further binds the sound to a specific joint on the model of the actor (string)
* ParentEnable - sets this binding to true. (boolean)
* Located - tells the sound to follow a position, whether from an attached creature or a direct position variable. (boolean)
* ID - the sound effect ID, in decimal. See [https://pikmintkb.com/wiki/Se.bms this page] for IDs. (int)
* Begin - starts the sound.
* BeginFadeIn - tells the sound to fade in when started, with the time it takes to fade in determined by the float after it.
* End - stops the sound.
* EndFadeOut - tells the sound to fade out when started, with the time it takes to fade out determined by the float after it.

Sound's variables are:

* Volume (float)
* Pan (float)
* Pitch (float)
* TempoProportion (float) - speed
* Fxmix (float) - reverb/echo
* Position (float) - XYZ sound position offset from the movie position

Let's add a sound effect and a text box to our cutscene. <br>

Text box first, we'll use message index 915 (in the BMG, this will show as hex, so it's actually 0x393) and have it appear at the end of the cutscene.

<pre>"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},</pre>

Due to a seemingly hardware dependent bug, the stb created by STB2JSON may have the "control block" represented as <code>0xEFBFBDEFBFBDEFBFBDEFBFBD</code> instead of <code>0xFFFFFFFF</code>, which is the correct one. If this happens, open your stb in a hex editor and change the offending bytes, making sure to delete the extra bytes.
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage1.png
</gallery>
<gallery mode="packed-hover" widths=200px heights=200px>
File:Messagetutorialimage2.png
</gallery>
Now let's test in game. <br>

<gallery mode="packed-hover" widths=400px heights=400px>
File:Messagetutorialimage3.png
</gallery>

Finally, let's add a sound. Let's play <code>PSSE_SY_WMAP_MONEY_UP</code> (one of the ka-ching sounds)
We're not going to tie it to any actor, just have it play on its own.

<pre>"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},</pre>

Our whole JSON should now look like this:
<pre>{
"JFVB": {
"Values": [
{
"Func": "Constant",
"Data": "45.0",
},
{
"Func": "Constant",
"Data": "0.0",
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"414.939424",
"0.0",
],
[
"18.83333145",
"-524.69691",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"313.322154",
"0.0",
],
[
"18.83333145",
"416.293478",
"0.0",
],
]
},
{
"Func": "Hermite",
"Range": "0.0 18.83333145",
"Data": [
[
"0.0",
"2703.901104",
"0.0",
],
[
"18.83333145",
"2444.029785",
"0.0",
],
]
},
{
"Func": "Constant",
"Data": "-308.449492",
},
{
"Func": "Constant",
"Data": "79.412207",
},
{
"Func": "Constant",
"Data": "3268.020343",
},
]
},
"JCMR": {
"Type": "camera",
"Commands": [
"VAR ProjFovy Index 0",
"VAR ViewRoll Index 1",
"VAR ViewPos Index 2 3 4",
"VAR TargPos Index 5 6 7",
"VAR Distance Immediate 1.0 12800.0",
"WAIT 565",
]
},
"JACT": {
"Type": "*theOrima",
"Commands": [
"SET MovieTranslation None",
"SET Anim BCK",
"SET AnimData 1",
"WAIT 565",
]
},
"JMSG": {
"Type": "message",
"Commands": [
"WAIT 564",
"SET Code 915 0",
"WAIT 1",
]
},
"JCNT": {
"Type": "control",
"Commands": [
"WAIT 565",
"SYNC 1",
"WAIT 1",
]
},
"JSND": {
"Type": "#bling",
"Commands": [
"WAIT 194",
"VAR Position Immediate 0.0 0.0 0.0",
"SET Located True",
"SET ID 6205",
"SET BeginFadeIn 0.0",
"WAIT 371",
]
},
}
</pre>
Convert your JSON to STB, remember to fix the control block if needed, repack your archive with WiiExplorer (make sure the file IDs are correct!), and play the cutscene in game.<br>

Congratulations, you have now made a full cutscene! Feel free to experiment with editing vanilla cutscenes, or making more of your own.

Screen file list (Pikmin 2)

2025-05-17T03:26:32Z

Iwillremembermypasswordthistime: add cave results page

Below is a file list of all screens in ''Pikmin 2''. Screen resources are usually contained in SZS archives, with BTI textures, BLO screen files and BCK/BPK/BTK animations within these archives.

__TOC__

== Contained in new_screen/cmn/ ==
{| class="wikitable"
! Archive name || Description || Image
|-
| <code>gold_pod_for_message_window.szs</code> || Post debt ship cutscene talk icon || [[File:Gold ship.png|90px]]
|-
| <code>message_window.szs</code> || Ship cutscene dialogue box || [[File:Ship dialogue.png|350px]]
|-
| <code>pod_for_message_window.szs</code> || Pre debt ship cutscene talk icon || [[File:Ship.png|90px]]
|-
| <code>res_map_image_forest.szs</code> || Awakening Wood radar map image || [[File:Aw radar.png|272px]]
|-
| <code>res_map_image_last.szs</code> || Wistful Wild radar map image || [[File:Ww radar.png|272px]]
|-
| <code>res_map_image_tutorial.szs</code> || Valley of Repose radar map image || [[File:Vor radar.png|272px]]
|-
| <code>res_map_image_yakushima.szs</code> || Perplexing Pool radar map image || [[File:Pp radar.png|272px]]
|-
| <code>result_image_final.szs</code> || Textures used for final results screen thumbnails || [[File:Final result images.png|256px|none]]
|}

== Contained in new_screen/(language folder)/ ==
{| class="wikitable"
! Archive name || Description || Image
|-
| <code>E3_title_menu.szs</code> || Unused E3 title screen with only 2 options ||
|-
| <code>file_select.szs</code> || File select screen || [[File:Pikmin2FileSelect.png|350px]]
|-
| <code>final_floor.szs</code> || Final floor of cave screen || [[File:Pikmin2FinalFloor.png|250px]]
|-
| <code>gameover_louie.szs</code> || Louie is down! screen || [[File:Pikmin2LouieIsDown.png|250px]]
|-
| <code>hensai_demo_kanryo.szs</code> || You repayed the entire debt! screen || [[File:FileSelect1.png|100px]]
|-
| <code>hensai_demo_otakara.szs</code> || You collected every treasure! screen || [[File:FileSelect1.png|100px]]
|-
| <code>hensai_demo_parsent.szs</code> || X% of debt recovered! screen || [[File:FileSelect1.png|100px]]
|-
| <code>info_window.szs</code> || Menu prompt for stuff like saving after a day is done || [[File:Pikmin2SaveWindow.png|250px]]
|-
| <code>memory_card.szs</code> || Memory card screens, appears when there's no memory card, no save data created, or if the memory card is corrupted || [[File:Pikmin2MemoryCardCheckScreen.png|350px]]
|-
| <code>omake.szs</code> || Title screen bonus menu/E reader menu || [[File:Pikmin2BonusMenu.png|350px]]
|-
| <code>option_jp.szs</code> || Japanese version of options screen || [[File:FileSelect1.png|100px]]
|-
| <code>option_pal.szs</code> || European version of options screen || [[File:FileSelect1.png|100px]]
|-
| <code>option_us.szs</code> || US version of options screen || [[File:Pikmin2OptionsMenu.png|350px]]
|-
| <code>progre.szs</code> || Enable progressive scan menu from game boot. Unused in Wii and Switch versions. || [[File:Pikmin2EnableProgressiveMode.png|250px]]
|-
| <code>ready_go.szs</code> || Ready/Go! screen from challenge mode/versus || [[File:FileSelect1.png|100px]]
|-
| <code>res_ana_demo.szs</code> || Cave entry screen, delve deeper screen, and geyser escape screen || [[File:Pikmin2CaveEntryScreen.png|300px]] [[File:Pikmin2DelveDeeperScreen.png|200px]] [[File:Pikmin2EscapeToSurfaceScreen.png|200px]]
|-
| <code>res_cave.szs</code> || Cave HUD || [[File:Pikmin2CaveHUD.png|350px]]
|-
| <code>res_challenge_1p.szs</code> || Challenge Mode 1-Player HUD || [[File:Pikmin2Challenge1pHUD.png|350px]]
|-
| <code>res_challenge_2p.szs</code> || Challenge Mode 2-Player HUD || [[File:2p challenge.png|350px]]
|-
| <code>res_challengeResult.szs</code> || Challenge Mode results screen || [[File:FileSelect1.png|100px]]
|-
| <code>res_challengeSelect.szs</code> || Challenge Mode main menu || [[File:Pikmin2ChallengeSelect.png|300px]] [[File:Pikmin2ChallengeRules.png|300px]]
|-
| <code>res_contena.szs</code> || Onion menus || [[File:Pikmin2BlueOnionMenu.png|250px]]
|-
| <code>res_course_name00.szs</code> || Valley of Repose loading screen || [[File:Pikmin2ValleyofReposeLoadingScreen.png|250px]]
|-
| <code>res_course_name01.szs</code> || Awakening Wood loading screen || [[File:Pikmin2AwakeningWoodLoadingScreen.png|250px]]
|-
| <code>res_course_name02.szs</code> || Perplexing Pool loading screen || [[File:Pikmin2PerplexingPoolLoadingScreen.png|250px]]
|-
| <code>res_course_name03.szs</code> || Wistful Wild loading screen || [[File:Pikmin2WistfulWildlLoadingScreen.png|250px]]
|-
| <code>res_dayend.szs</code> || Unused sunset approaching screen resources (used resources are in res_ground) || [[File:FileSelect1.png|100px]]
|-
| <code>res_enemyZukan.szs</code> || Piklopedia screen || [[File:Pikmin2Piklopedia.png|350px]]
|-
| <code>res_final_message.szs</code> || "Return to planet and resume expedition?" screen || [[File:Pikmin2ReturnToPlanetMessage.png|250px]]
|-
| <code>res_floor_name.szs</code> || Unused cave loading screen ||
|-
| <code>res_floor_name_eng_pal.szs</code> || US/PAL cave loading screen || [[File:Pikmin2StoryCaveLoadScreen.png|250px]] [[File:Pikmin2ChallengeModeLoadScreen.png|250px]] [[File:Pikmin2VsModeLoadScreen.png|250px]]
|-
| <code>res_floor_name_jpn.szs</code> || Japanese cave loading screen || [[File:FileSelect1.png|100px]]
|-
| <code>res_gameover.szs</code> || Unused Game Over! screen ||
|-
| <code>res_ground.szs</code> || [[Ground HUD | Overworld HUD]] || [[File:Pikmin2GroundHUD.png|350px]]
|-
| <code>res_hiscore.szs</code> || Title screen high scores menu || [[File:Pikmin2HighScoresMenu.png|350px]]
|-
| <code>res_hiscoreTexture.szs</code> || Thumbnails for high scores screen || [[File:high score images.png|350px]]
|-
| <code>res_itemZukan.szs</code> || Treasure Hoard screen || [[File:Pikmin2TreasureHoard.png|350px]]
|-
| <code>res_kantei.szs</code> || Treasure Collected screen || [[File:FileSelect1.png|100px]]
|-
| <code>res_lujidown.szs</code> || Unused Louie is down screen ||
|-
| <code>res_orimadown.szs</code> || Olimar is down! screen || [[File:Pikmin2OlimarIsDown.png|250px]]
|-
| <code>res_pikmindown.szs</code> || Pikmin Extinction! screen || [[File:Pikmin2PikminExtinction.png|250px]]
|-
| <code>res_presidentdown.szs</code> || President is down! screen || [[File:Pikmin2PresidentIsDown.png|250px]]
|-
| <code>res_s_menu_controller.szs</code> || Unused game controls pause screen || [[File:Pause controls.png|350px]]
|-
| <code>res_s_menu_item.szs</code> || Collected upgrades and berries pause screen || [[File:Pause items.png|350px]]
|-
| <code>res_s_menu_map.szs</code> || Radar map and Pikmin count pause screen || [[File:Pause radar.png|350px]]
|-
| <code>res_s_menu_pause.szs</code> || Total pokos and skip to sunset pause screen || [[File:Pause menu.png|350px]]
|-
| <code>res_s_menu_pause_doukutu.szs</code> || Total pokos and give up cave pause screen || [[File:Pause cave.png|350px]]
|-
| <code>res_s_menu_pause_VS.szs</code> || Pause in challenge/vs mode screen, also used for other stuff || [[File:Pause side modes.png|350px]]
|-
| <code>res_special_item.szs</code> || Collection screen for items like berries and spray drops || [[File:FileSelect1.png|100px]]
|-
| <code>res_ufo.szs</code> || Purple or White Pikmin selection ship menu || [[File:Pikmin2PurplesAndWhitesSelection.png|250px]]
|-
| <code>res_vs.szs</code> || Main 2-Player Battle HUD || [[File:Pikmin2VsHUD.png|350px]]
|-
| <code>res_vsSelect.szs</code> || 2-Player Battle main menu || [[File:Pikmin2VsModeSelect.png|300px]][[File:Pikmin2VsModeRules.png|300px]]
|-
| <code>res_vsSelectTexture.szs</code> || 2-Player Battle stage thumbnails, Olimar and Louie icons, and item icons || [[File:Vsselecttexture.png|350px]]
|-
| <code>res_world_map_info_window0.szs</code> || World map do you return to title screen || [[File:Pikmin2Worldmapinfowindow0.png|300px]]
|-
| <code>res_world_map_info_window1.szs</code> || World map do you land in this area screen || [[File:Pikmin2Worldmapinfowindow1.png|300px]]
|-
| <code>result_doukutu.szs</code> || [[Cave_Results_menu_(Pikmin_2) | Cave results screen]] || [[File:Pikmin2CaveResults.png|350px]]
|-
| <code>result_final.szs</code> || Debt repaid/All treasures final results screen || [[File:Pikmin2DebtResults.png|350px]][[File:Pikmin2FinalResults.png|350px]]
|-
| <code>result_fueta.szs</code> || Unused day results Pikmin grown screen ||
|-
| <code>result_fuetaheta.szs</code> || Day results Pikmin grown and Pikmin deaths screen || [[File:Pikmin2Dayendpikmintotals.png|350px]][[File:Pikmin2Dayendpikmindeaths.png|350px]]
|-
| <code>result_heta.szs</code> || Unused day results Pikmin deaths screen ||
|-
| <code>result_item.szs</code> || Day results treasures collected screen || [[File:FileSelect1.png|100px]]
|-
| <code>result_mail.szs</code> || Day results mail screen || [[File:Mail.png|350px]]
|-
| <code>result_title_new.szs</code> || Today's Report end of day results screen || [[File:Pikmin2TodaysReport.png|350px]]
|-
| <code>title.szs</code> || Main title screen menu || [[File:Pikmin2TitleScreenMenu.png|250px]]
|-
| <code>win_lose.szs</code> || 2-Player Battle win/lose/draw/time up results screen || [[File:FileSelect1.png|100px]][[File:FileSelect1.png|100px]][[File:FileSelect1.png|100px]][[File:FileSelect1.png|100px]]
|-
| <code>win_lose_reason.szs</code> || Like above but for Olimar is Down! or Pikmin Extinction! || [[File:FileSelect1.png|100px]][[File:FileSelect1.png|100px]]
|-
| <code>worldmap.szs</code> || World map screen || [[File:Pikmin2WorldMap.png|350px]]
|}

Cave Results menu (Pikmin 2)

2025-05-17T03:24:51Z

Iwillremembermypasswordthistime: add more images

This menu is shown when you exit a cave.

__TOC__

== Screen files ==
{| class="wikitable"
! Description || BLO Filename || Animation files || Image
|-
| Main screen || <code>result_doukutu.blo</code> || <code>result_doukutu.bck</code><br> <code>result_doukutu.brk</code><br> <code>result_doukutu.bpk</code><br> <code>result_doukutu.btk<br></code>|| [[File:Resultdoukutumain.png|450px]]
|-
| Screen for lost items || <code>result_doukutu_drop_item.blo</code> || N/A || N/A
|-
| "Cave Complete!" || <code>doukutu_complete.blo</code> || <code>doukutu_complete.bck</code> <br> <code>doukutu_complete.bpk</code> || [[File:Cavecomplete.gif|450px]]
|-
| Control stick icon || <code>tga_3d_anim_otah.blo</code> || <code>tga_3d_anim_otah.btp</code> || [[File:Controlstickicon.png|300px]]
|}

[[Category:Pikmin 2]]

File:Cavecomplete.gif

2025-05-17T03:23:55Z

Iwillremembermypasswordthistime:

Cave Results menu (Pikmin 2)

2025-05-17T03:17:30Z

Iwillremembermypasswordthistime: create cave results screen page

This menu is shown when you exit a cave.

__TOC__

== Screen files ==
{| class="wikitable"
! Description || BLO Filename || Animation files || Image
|-
| Main screen || <code>result_doukutu.blo</code> || <code>result_doukutu.bck</code><br> <code>result_doukutu.brk</code><br> <code>result_doukutu.bpk</code><br> <code>result_doukutu.btk<br></code>|| [[File:Resultdoukutumain.png|300px]]
|-
| Screen for lost items || <code>result_doukutu_drop_item.blo</code> || N/A || N/A
|-
| "Cave Complete!" || <code>doukutu_complete.blo</code> || <code>doukutu_complete.bck</code> <br> <code>doukutu_complete.bpk</code> || [[File:Gauge.png|300px]]
|-
| Control stick icon || <code>tga_3d_anim_otah.blo</code> || <code>tga_3d_anim_otah.btp</code> || [[File:Controlstickicon.png|450px]]
|}

[[Category:Pikmin 2]]