Super Hackio: Added basic information on UseResource

2024-01-27T17:14:28Z

Added basic information on UseResource

New page

[[Category:Files]]
{{WIP}}

This page only applies to ''Super Mario Galaxy 2''

UseResource is an archive that only the main galaxy can have. It provides the game with a list of items from the disc that will be loaded into memory asynchronously, which makes loading faster.

It is important to note that if a file that is inside UseResource doesn't exist, the game will hang while loading the scene.

== Naming Convention ==
These UseResource files use the following naming convention:
{| class="wikitable"
|-
! Scenario Target !! Filename !! Examples
|-
| All Scenarios || common || common.bcsv, sound_common.bcsv
|-
| Scenario X || scenario_X || scenario_1.bcsv, sound_scenario_3.bcsv<br/>(basically just replace the "X" with the scenario number)
|}

== File Lists ==
=== Standard Files ===
A UseResource BCSV to load files into memory.
{| class="wikitable"
|-
! Field !! Type !! Description
|-
| ResourceName || STRING || Put the game disc path to a file that you want to load here.<br/>Example: '''/ObjectData/Kuribo.arc'''
|}
=== Sounds ===
A UseResource BCSV to load sounds by name into memory. Be aware that there is an unknown maximum to how many sounds that can be loaded at once.
{| class="wikitable"
|-
! Field !! Type !! Description
|-
| SoundName || STRING || Put the name of the sfx you want to load here.<br/>Example: '''SE_PM_SPIN_ATTACK'''
|}

== Unused Files ==
Inside a UseResource are files named "wave_arc_<Scenario>.bcsv". These are not used by the game for anything, and can be deleted freely. It is assumed that they used to load specific .aw files during development.<br/>For completeness, the BCSV is documented below.
{| class="wikitable"
|-
! Field !! Type
|-
| WaveArcName|| STRING
|}

UseResource - Revision history

Super Hackio: Added basic information on UseResource