ZeldaMods (Breath of the Wild) - User contributions [en]

Graphics

2021-05-06T22:52:52Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=Graphics|is_name_official=1|description=-|init_addr_switch150=0000007100F2A1D0|init_addr_wiiu150=034059FC}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

UI

2021-05-05T18:29:08Z

NiceneNerd:

{{stub}}

== Screens ==
A '''screen''' is a set of UI elements. There can be several visible screens on the screen at the same time.

Screens can optionally take over controller input when they are activated. Screen layouts can reference other UI widgets (these have the Pa prefix in their names).

=== List of screens (1.5.0) ===
{| class="wikitable"
! ID !! Name !! Description
|-
| 0 || GamePadBG_00 ||
|-
| 1 || Title_00 || Title screen
|-
| 2 || MainScreen3D_00 ||
|-
| 3 || Message3D_00 ||
|-
| 4 || AppCamera_00 ||
|-
| 5 || WolfLinkHeartGauge_00 ||
|-
| 6 || EnergyMeterDLC_00 ||
|-
| 7 || MainHorse_00 ||
|-
| 8 || MiniGame_00 ||
|-
| 9 || ReadyGo_00 ||
|-
| 10 || KeyNum_00 ||
|-
| 11 || MessageGet_00 ||
|-
| 12 || DoCommand_00 ||
|-
| 13 || SousaGuide_00 ||
|-
| 14 || GameTitle_00 ||
|-
| 15 || DemoName_00 ||
|-
| 16 || DemoNameEnemy_00 ||
|-
| 17 || MessageSp_00_NoTop ||
|-
| 18 || ShopBG_00 ||
|-
| 19 || ShopBtnList5_00 ||
|-
| 20 || ShopBtnList20_00 ||
|-
| 21 || ShopBtnList15_00 ||
|-
| 22 || ShopInfo_00 ||
|-
| 23 || ShopHorse_00 ||
|-
| 24 || Rupee_00 ||
|-
| 25 || KologNum_00 ||
|-
| 26 || AkashNum_00 ||
|-
| 27 || MamoNum_00 ||
|-
| 28 || Time_00 ||
|-
| 29 || PauseMenuBG_00 ||
|-
| 30 || SeekPadMenuBG_00 ||
|-
| 31 || AppTool_00 ||
|-
| 32 || AppAlbum_00 ||
|-
| 33 || AppPictureBook_00 ||
|-
| 34 || AppMapDungeon_00 ||
|-
| 35 || MainScreenMS_00 || Centered heart gauge (for Master Sword pulling demo). Automatically created and opened if the IsCenterHeartGauge_Demo GameData flag is set.
|-
| 36 || MainScreenHeartIchigekiDLC_00 ||
|-
| 37 || MainScreen_00 || Main UI (quest notifications, arrow num, location text, weather, time, map, etc.)
|-
| 38 || MainDungeon_00 || Dungeon name screen
|-
| 39 || ChallengeWin_00 ||
|-
| 40 || PickUp_00 ||
|-
| 41 || MessageTipsRunTime_00 ||
|-
| 42 || AppMap_00 ||
|-
| 43 || AppSystemWindowNoBtn_00 ||
|-
| 44 || AppHome_00 ||
|-
| 45 || MainShortCut_00 ||
|-
| 46 || PauseMenu_00 ||
|-
| 47 || PauseMenuInfo_00 ||
|-
| 48 || GameOver_00 || Game over screen
|-
| 49 || HardMode_00 ||
|-
| 50 || SaveTransferWindow_00 ||
|-
| 51 || MessageTipsPauseMenu_00 ||
|-
| 52 || MessageTips_00 ||
|-
| 53 || OptionWindow_00 ||
|-
| 54 || AmiiboWindow_00 ||
|-
| 55 || SystemWindowNoBtn_00 ||
|-
| 56 || ControllerWindow_00 ||
|-
| 57 || SystemWindow_01 ||
|-
| 58 || SystemWindow_00 ||
|-
| 59 || PauseMenuRecipe_00 ||
|-
| 60 || PauseMenuMantan_00 ||
|-
| 61 || PauseMenuEiketsu_00 ||
|-
| 62 || AppSystemWindow_00 ||
|-
| 63 || DLCWindow_00 ||
|-
| 64 || HardModeTextDLC_00 ||
|-
| 65 || TestButton ||
|-
| 66 || TestPocketUIDRC ||
|-
| 67 || TestPocketUITV ||
|-
| 68 || BoxCursorTV ||
|-
| 69 || FadeDemo_00 ||
|-
| 70 || StaffRoll_00 ||
|-
| 71 || StaffRollDLC_00 ||
|-
| 72 || End_00 ||
|-
| 73 || DLCSinJuAkashiNum_00 ||
|-
| 74 || MessageDialog ||
|-
| 75 || DemoMessage ||
|-
| 76 || MessageSp_00 ||
|-
| 77 || Thanks_00 || E3 2016 Thanks screen ("Thank you for playing!")<ref>https://youtu.be/U3l4W7W--pY?t=2824</ref>
|-
| 78 || Fade || Fade screen and also loading screen
|-
| 79 || KeyBoradTextArea_00 ||
|-
| 80 || LastComplete_00 ||
|-
| 81 || OPtext_00 ||
|-
| 82 || LoadingWeapon_00 ||
|-
| 83 || MainHardMode_00 ||
|-
| 84 || LoadSaveIcon_00 ||
|-
| 85 || FadeStatus_00 || Upper part of the loading screen (heart, stamina, shrine info, ...)
|-
| 86 || Skip_00 || Skip prompt (bottom right)
|-
| 87 || ChangeController_00 ||
|-
| 88 || ChangeControllerDRC_00 ||
|-
| 89 || DemoStart_00 ||
|-
| 90 || BootUp_00 ||
|-
| 91 || BootUp_00 ||
|-
| 92 || ChangeControllerNN_00 ||
|-
| 93 || AppMenuBtn_00 ||
|-
| 94 || HomeMenuCapture_00 ||
|-
| 95 || HomeMenuCaptureDRC_00 ||
|-
| 96 || HomeNixSign_00 ||
|-
| 97 || ErrorViewer_00 ||
|-
| 98 || ErrorViewerDRC_00 ||
|}

== Subsystem ==
{{Subsystem infobox|name=UI|is_name_official=1|description=-|init_addr_switch150=00000071010A5714|init_addr_wiiu150=035FD518}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

UI

2021-05-05T18:28:48Z

NiceneNerd: Added Wii U init address

{{stub}}

== Screens ==
A '''screen''' is a set of UI elements. There can be several visible screens on the screen at the same time.

Screens can optionally take over controller input when they are activated. Screen layouts can reference other UI widgets (these have the Pa prefix in their names).

=== List of screens (1.5.0) ===
{| class="wikitable"
! ID !! Name !! Description
|-
| 0 || GamePadBG_00 ||
|-
| 1 || Title_00 || Title screen
|-
| 2 || MainScreen3D_00 ||
|-
| 3 || Message3D_00 ||
|-
| 4 || AppCamera_00 ||
|-
| 5 || WolfLinkHeartGauge_00 ||
|-
| 6 || EnergyMeterDLC_00 ||
|-
| 7 || MainHorse_00 ||
|-
| 8 || MiniGame_00 ||
|-
| 9 || ReadyGo_00 ||
|-
| 10 || KeyNum_00 ||
|-
| 11 || MessageGet_00 ||
|-
| 12 || DoCommand_00 ||
|-
| 13 || SousaGuide_00 ||
|-
| 14 || GameTitle_00 ||
|-
| 15 || DemoName_00 ||
|-
| 16 || DemoNameEnemy_00 ||
|-
| 17 || MessageSp_00_NoTop ||
|-
| 18 || ShopBG_00 ||
|-
| 19 || ShopBtnList5_00 ||
|-
| 20 || ShopBtnList20_00 ||
|-
| 21 || ShopBtnList15_00 ||
|-
| 22 || ShopInfo_00 ||
|-
| 23 || ShopHorse_00 ||
|-
| 24 || Rupee_00 ||
|-
| 25 || KologNum_00 ||
|-
| 26 || AkashNum_00 ||
|-
| 27 || MamoNum_00 ||
|-
| 28 || Time_00 ||
|-
| 29 || PauseMenuBG_00 ||
|-
| 30 || SeekPadMenuBG_00 ||
|-
| 31 || AppTool_00 ||
|-
| 32 || AppAlbum_00 ||
|-
| 33 || AppPictureBook_00 ||
|-
| 34 || AppMapDungeon_00 ||
|-
| 35 || MainScreenMS_00 || Centered heart gauge (for Master Sword pulling demo). Automatically created and opened if the IsCenterHeartGauge_Demo GameData flag is set.
|-
| 36 || MainScreenHeartIchigekiDLC_00 ||
|-
| 37 || MainScreen_00 || Main UI (quest notifications, arrow num, location text, weather, time, map, etc.)
|-
| 38 || MainDungeon_00 || Dungeon name screen
|-
| 39 || ChallengeWin_00 ||
|-
| 40 || PickUp_00 ||
|-
| 41 || MessageTipsRunTime_00 ||
|-
| 42 || AppMap_00 ||
|-
| 43 || AppSystemWindowNoBtn_00 ||
|-
| 44 || AppHome_00 ||
|-
| 45 || MainShortCut_00 ||
|-
| 46 || PauseMenu_00 ||
|-
| 47 || PauseMenuInfo_00 ||
|-
| 48 || GameOver_00 || Game over screen
|-
| 49 || HardMode_00 ||
|-
| 50 || SaveTransferWindow_00 ||
|-
| 51 || MessageTipsPauseMenu_00 ||
|-
| 52 || MessageTips_00 ||
|-
| 53 || OptionWindow_00 ||
|-
| 54 || AmiiboWindow_00 ||
|-
| 55 || SystemWindowNoBtn_00 ||
|-
| 56 || ControllerWindow_00 ||
|-
| 57 || SystemWindow_01 ||
|-
| 58 || SystemWindow_00 ||
|-
| 59 || PauseMenuRecipe_00 ||
|-
| 60 || PauseMenuMantan_00 ||
|-
| 61 || PauseMenuEiketsu_00 ||
|-
| 62 || AppSystemWindow_00 ||
|-
| 63 || DLCWindow_00 ||
|-
| 64 || HardModeTextDLC_00 ||
|-
| 65 || TestButton ||
|-
| 66 || TestPocketUIDRC ||
|-
| 67 || TestPocketUITV ||
|-
| 68 || BoxCursorTV ||
|-
| 69 || FadeDemo_00 ||
|-
| 70 || StaffRoll_00 ||
|-
| 71 || StaffRollDLC_00 ||
|-
| 72 || End_00 ||
|-
| 73 || DLCSinJuAkashiNum_00 ||
|-
| 74 || MessageDialog ||
|-
| 75 || DemoMessage ||
|-
| 76 || MessageSp_00 ||
|-
| 77 || Thanks_00 || E3 2016 Thanks screen ("Thank you for playing!")<ref>https://youtu.be/U3l4W7W--pY?t=2824</ref>
|-
| 78 || Fade || Fade screen and also loading screen
|-
| 79 || KeyBoradTextArea_00 ||
|-
| 80 || LastComplete_00 ||
|-
| 81 || OPtext_00 ||
|-
| 82 || LoadingWeapon_00 ||
|-
| 83 || MainHardMode_00 ||
|-
| 84 || LoadSaveIcon_00 ||
|-
| 85 || FadeStatus_00 || Upper part of the loading screen (heart, stamina, shrine info, ...)
|-
| 86 || Skip_00 || Skip prompt (bottom right)
|-
| 87 || ChangeController_00 ||
|-
| 88 || ChangeControllerDRC_00 ||
|-
| 89 || DemoStart_00 ||
|-
| 90 || BootUp_00 ||
|-
| 91 || BootUp_00 ||
|-
| 92 || ChangeControllerNN_00 ||
|-
| 93 || AppMenuBtn_00 ||
|-
| 94 || HomeMenuCapture_00 ||
|-
| 95 || HomeMenuCaptureDRC_00 ||
|-
| 96 || HomeNixSign_00 ||
|-
| 97 || ErrorViewer_00 ||
|-
| 98 || ErrorViewerDRC_00 ||
|}

== Subsystem ==
{{Subsystem infobox|name=UI|is_name_official=1|description=-|init_addr_switch150=00000071010A5714|init_addr_wiiu150}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

AutoPlacementMgr

2021-04-30T19:43:12Z

NiceneNerd:

{{Subsystem infobox|name=AutoPlacementMgr|is_name_official=1|description=Dynamically spawns actors on the map depending on complex conditions (areas, terrain, event flows, custom logic).|init_addr_switch150=00000071006546FC|init_addr_wiiu150=029FB6DC}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

AutoPlacementMgr

2021-04-30T19:39:32Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=AutoPlacementMgr|is_name_official=1|description=Dynamically spawns actors on the map depending on complex conditions (areas, terrain, event flows, custom logic).|init_addr_switch150=00000071006546FC|init_addr_wiiu150=029FB6dC}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

PlacementMgr

2021-04-30T18:13:49Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=PlacementMgr|is_name_official=1|description=Reads [[map unit]] ([[mubin]]) files and spawns actors|init_addr_switch150=00000071011E451C|init_addr_wiiu150=037C0688}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

GameScene

2021-04-30T16:16:55Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=GameScene|is_name_official=1|description=Handles the main loop and stages|init_addr_switch150=0x71007D1DD8|init_addr_wiiu150=02C23480}}

'''GameScene''' is a critical subsystem that is responsible for core functionality such as initialising other components, creating [[Stage|stages]] (world, title screen, etc.) and handling the game's main loop.

Unlike most other subsystems, GameScene is not a singleton: it is a member of the uking::frm::System structure<ref>uking::frm::System::gameScene @ 0x10 (Switch)</ref>.

==Definitions==
===Stages===
Also called scenes in XLink code.
{| class="wikitable"
!Type
!Description
!Map types
|-
|0
|Invalid ("None")
| -
|-
|1
|Open world stage (except GameTestField) ("オープンワールド")
|MainField, AocField
|-
|2
|Indoor stage ("Cダンジョン")
|CDungeon, MainFieldSpot, GameTestDungeon
|-
|3
|Open world stage (GameTestField) ("GameTset")
|GameTestField
|-
|4
|MainFieldDungeon ("四大遺物")
|MainFieldDungeon
|-
|5
|Indoor stage or viewer stage ("ビューワー")
|ActorViewer
|}
Maps that have the same stage type typically use the same subsystems and share most characteristics. For example, all open world stages use the [[Tera]] height map terrain system and load [[Map unit|map units]] in the same way.

===StageBinders===
{| class="wikitable"
|+Stage binder types<ref>As returned by the first virtual function in the StageBinderBase interface</ref>
!Type!!Description
|-
|0||OpenWorldStage
|-
|1||IndoorStage (CDungeon, ...)
|-
|2||MainFieldDungeonStage
|-
|3||TitleStage
|-
|4||StartupSaveCheckStage
|-
|5||Viewer
|}

===Fade types===
{| class="wikitable"
!Type!!Description
|-
|0||
|-
|1||
|-
|2||Show logo<ref>See 0x71007B8CD0 and [[AIDef:Action/ExitGame]]</ref>
|}

===GameScene state strings===
{| class="wikitable"
|+List of state strings in 1.5.0 (incomplete)<ref>The state string is a sead::FixedSafeString<0x100> stored in GameScene @ 0x720.</ref>
!Name!!Description
|-
|1st||Demo mode {{check}}
|-
|2nd||Demo mode
|-
|初回シーケンス||Initial sequence - New save
|-
|TitleMenu||Title menu
|-
|Presentation||Demo mode
|-
|E3_2016/Presentation||Demo mode
|-
|StartupSaveCheckStage||
|-
|Viewer||
|-
|CDungeon||Shrine world
|-
|MainFieldDungeonStage||Divine beasts and final trial
|-
|MainField||The normal overworld
|-
|GameTestField||
|-
|GameTestField2||
|-
|AocField||Trial of the Sword world
|-
|GameTestDungeon||
|-
|MonolithTestDungeon||
|-
|SrdTestDungeon||
|-
|MarioClubTestDungeon||
|-
|TestField||
|-
|研修用||
|-
|MonolithTest100enemy||
|-
|MinimumField||
|-
|ActorViewer||
|}

==Init==

*'''GameScene::initialize''' (0x71007A8014)
**Load the environment graphics archive ([[Content/Env/env.genvb|env.genvb]])
**Create the GameScene heap
**Create the [[StageBinder]] heap
**Start the GameScene TaskMgr (thread)
**'''InitializeSubSystem''' (note: some of the below names are unofficial, see [[Subsystems]] for more details)
***[[AutoPlacementFlowMgr]]
***[[FadeProgress]]
***[[DungeonPackMgr]]
***[[PlayerInfo]]
***[[GameSceneSubsys2]]
***[[Resetter]]
***[[GameSceneSubsys4]]
***[[GameSceneSubsys5]]
***[[ActorHeapUtil]]
***[[E3Mgr]]
***[[aoc2]]
***[[aoc3]]
***[[GameSceneSubsys6]]
***[[CookingMgr]]
***[[GameSceneSubsys7]]
***[[ActorLimiter]]
***[[RuneMgr]]
***[[StasisMgr]]
***[[IceBlockMgr]]
***[[AmiiboMgr]]
***[[DropMgr]]
***[[GameSceneSubsys12]]
***[[GameSceneSubsys13]]
***[[GameSceneSubsys14]]
***[[GameSceneSubsys15]]
***[[ResidentActorMgr]]
***Create UI heap
***[[uiManager]]
***Load the [[Fade]] screen
***[[OnUiActorMgr]]
***[[CreatePlayerEquipActorMgr]]
***[[CreatePlayerTrashActorMgr]]
***[[TipsMgr]]
***[[nxargs]]
***GameScene::initializeGraphicsLayer_
***ErrorViewerTask init
***Set Get Demo handler
***Set Check Weapon Free Slot handler (1, 2)
***...
***[[SaveSystem]] init
***Set [[#Initial state|initial state]]
***nn::err::ShowUnacceptableAddOnContentVersionError if needed
****[Debug] StarterPackMgr: Load Title pack
****[[GlobalParameter]]
****GlobalParameter: Load [[actorpack]]
****E3Mgr: Load [[Content/System/BuildTime.txt|System/BuildTime.txt]] (stubbed in release versions)
****TipsMgr: Load tips
****ResidentActorMgr: Load configuration ([[ResidentActors.byml]])
****AutoPlacementFlowMgr: Load auto placement [[event flow]]s
***KingEditor: Stubbed
***E3Mgr: init

===Initial state===
The initial state the game launches into is determined by GameScene<ref>GameScene::initialize, 0x71007A86CC</ref>.

<source lang="cpp">
const bool isFirstLaunch = SaveSystem::sInstance->isFirstLaunch();
State* state = isFirstLaunch ? &state_NewSave : &state_LunchTitle;

if ( aocManager::sInstance && aocManager::sInstance->flags & 2 )
nn::err::ShowUnacceptableAddOnContentVersionError();

const bool isDemo = E3Mgr::sInstance && E3Mgr::sInstance->isDemoMode();
if (isDemo)
state = &state_LunchTitle;

if (!isDemo && isFirstLaunch)
sIsFirstNonDemoLaunch = 1;

StateMachine::changeState(&this->stateMachine, state);
</source>

==States==
Note: when the Indoor stage binder is initialised and if the map name changes, a "dungeon" [[telemetry]] report is emitted with "leave" or "enter" as the event name and the old/new map name as additional data<ref>StageBinder::initAndReportDungeonLeaveEnter{{un}} at 0x71007B79A8</ref>.

===StageMgr===
{{empty section}}
===StageSelect===
{{empty section}}
===StageTransition===
Entered before stage generation starts and after Fade (loading screen) has been initialised and made visible. This state machine state is a noop.

===LunchTitle===
LunchTitle (sic) is entered when the game is launched. The internal state string is "TitleMenu" or (in demo mode) "2nd".

The run function is extremely simple: it simply creates the TitleStage binder (with doNotShowLogo=true<ref>0x71007B47D8</ref>) when the "common run" status (see below) is 0xa, then calls the "common run" function (with isNewSave=false<ref>0x71007B47F4</ref>).

===NewSave===
{{expand section}}
Entered on the first boot or when the new game option is selected. The associated state string is "初回シーケンス" ("initial sequence").

===PatchError===
{{empty section}}

==Main loop==
Three GameScene functions are called in a row from RootTask (see [[Executable]]) after initialisation has completed, i.e. in the game's main loop. (Note: these 3 names are unofficial.)

===precalc===

*FadeProgress: Update the progress gauge on the Fade screen (animated).
*Update current map name based on player position (when Link is not in a dungeon).
*Run StageMgr and StageSelect code.
*If a flag is set, run the final step of stage generation. (Unused?)
*If stage status is "NeedsGeneration":
**Call some [[MCMgr]] function at 0x71007A9198.
**Run save upload subsystem if needed.
**Call GameScene::genStage with second argument being <code>!EventMgr::sInstance->hasActiveEvent() || EventMgr::sInstance->getActiveEvent()->name != "Demo169_0"</code>.
*If stage status is "NeedsUnload":
**Call some [[MCMgr]] function at 0x71007A9198.
**Run save upload subsystem if needed.
**Call GameScene::unloadStage.
*If no stage is being unloaded, call <code>this->activeStageBinder->getStage()->preCalc</code>.
*??? (something involving GameScene Subsystem #12)
*Call some [[MCMgr]] function at 0x71007A9198, again.
*If the current state is StageMgr:
**Reset the current stage binder by setting a flag for StageMgr if needed (after a Blood Moon{{check}})
**If a forced blood moon is ready
***If panic blood moons can be triggered (see [[Blood moon#Panic blood moon inhibitors]]), call the Blood Moon demo (Demo011_0).
***Report the panic blood moon via the [[telemetry]] system.
**If any [[Blood moon#Panic Blood Moons|panic condition]] is true, and if panic blood moons are enabled<ref>GameConfig::sInstance->disablePanicBloodMoons (@ 0x3da on Switch 1.5.0) must be false.</ref>, request a panic blood moon by setting a SkyMgr flag. SkyMgr will start a 90 frame timer (3 seconds) and set a ready flag once it has expired. The timer is reset every time the panic blood moon is temporarily inhibited.

===calc===
{{empty section}}
===postcalc===
{{empty section}}

==Common state run function==
Called from StageSelectRun, LunchTitleRun and NewSaveRun.

*Status 0:
**Start loading
***Finish startup logo (Switch)<ref>0x71007AF6F8</ref>
***If the state string is set to 初回シーケンス, clear the Resource system cache ("ClearAllCaches")<ref>0x71007AFBDC</ref>.
***Debug stuff<ref>0x71007AFDE4</ref>.
***E3 Demo stuff<ref>0x71007AFEF4</ref>.
***Show the Fade screen (loading screen) if the state string does ''not''<ref>0x71007AFF08</ref> end with "Viewer" or is ''not'' any of the following strings: 1st, 2nd, Presentation, TitleMenu, 初回シーケンス, StartupSaveCheckStage
****And then show the FadeStatus<ref>0x71007AFFC4</ref> and the LoadSaveIcon screens<ref>0x71007AFFCC</ref>.
****Otherwise, only open the Fade screen but do not show loading progress<ref>See function at 0x71007B0C60</ref>.
***StageSelect stuff<ref>0x71007B0000</ref>.
***Stop "resource compaction" and wait for it to be stopped<ref>0x71007B00B4 (stop compaction) to 0x71007B010C (end of the busy loop)</ref>.
***If the stage string starts with CDungeon<ref>0x71007B0124</ref> or MainFieldDungeonStage<ref>0x71007B0160</ref>, start loading the associated DungeonPack<ref>0x71007B0190</ref>.
***BaseProcMgr: start ActorCreate initializer thread<ref>0x71011BF1C4</ref>{{check}}.
***FadeProgress: reset internal state<ref>0x71007B01D4</ref>, set progress to 0%<ref>0x71007B01E0</ref> and mark loading as active<ref>0x71007B01E8</ref>.
*Status 2:
**If the GameScene state machine's current state is StageSelect or NewSave, do something involving LayerMgrTask and the Renderer.{{check}}
*Status 0xa:
**TipsMgr: update tips if the loading screen is ''visible'' (not just opened). TipsMgr will load tips depending on the stage that is being loaded.
*Status 0xb:
**Set GameScene's isNewSave property.
**Reset status to 0.
**Change GameScene state to StageTransition<ref>0x71007B1058</ref>.
**Set stage status to "NeedsGeneration" (2)<ref>0x71007B105C</ref>.

==Stage generation==

*Terrain::sInstance->flags |= 0x180u
*Step 0
**Reload Title.pack if the stage that needs to be generated is TitleStage (3)<ref>0x71007AC8A0</ref>.
**StageSelect checks<ref>0x71007AD3AC</ref>
*Step 1
**If a pack was loaded by DungeonPackMgr, wait for DungeonPack loading to finish<ref>DungeonPack読み込み待ち</ref> and switch active pack to the [[dungeon pack]].
*Step 2
**If the stage to load is TitleStage, wait for TitlePack loading to finish<ref>TitlePack読み込み待ち</ref> and switch active pack to the title pack.
*Step 3: start stage generation<ref>ステージ生成開始</ref>
**PlacementMgr
**ActorSystem::sInstance->field_13A = 0
**Update current map flags (e.g. sIsDungeon)
**Clear BaseProcMgr ActorCreate queue{{check}}
**Create uking::Stage::ForBaseProcDual heap (if not already done), which will be used for actors, ActorCreator and BaseProcMgr
**ActorSystem::sInstance->field_139 = 0
**If the [[#State strings|state string]] starts with 初回シーケンス, MainField, GameTestField, GameTestField2, AocField, CDungeon, MainFieldDungeonStage, GameTestDungeon, MonolithTestDungeon, SrdTestDungeon, MarioClubTestDungeon, TestField, 研修用, MonolithTest100enemy, MinimumField, or ActorViewer, call GameScene::startBgProcessing (0x71007B2054)
**If "new save" was selected, initialize PauseMenuDataMgr data
**If the stage to load is TitleStage, load Layout/Title.blarc for ui::LayoutResourceMgr.
**If "new save" was selected and the awakening demo hasn't been played since the game was launched<ref>0x71007ADB3C</ref>, ask [[EventMgr]] to call Demo169_0.
**Some PhysicsMemSys stuff (0x71007ADBE0).
*Step 4
**Wait for completion of Title BG processing '''(20% of the loading bar)'''
**uiManager (0x71007ACD04)
**Initialize StatisticsMgr paths depending on current map type.
**Update aoc2's mapType and mapName fields.
*Step 5
**PhysicsMemSys stuff (0x71007ACDB8, 0x71007ACDC0, 0x71007ACDD0)
**BaseProcMgr: request "PreDelete" actors<ref>0x71007ACDE4</ref>
**BaseProcMgr: stop ActorCreate initializer thread and clean up internal state{{check}}
**agl::lyr::Renderer and Graphics stuff
*Step 6
**Load [[env.genvb]] binary (gsys::ModelSceneEnv::clearImpl + loadBinaryImpl)
**If the stage binder type is 0, 1 or 2 (OpenWorldStage, IndoorStage or MainFieldDungeonStage):
***'''Set loading progress to 40%.'''
***Graphics stuff, again
***OnUiActorMgr
***GameScene::loadTera (on a separate thread)
*Step 7
**If the stage binder type is 0, 1 or 2 (OpenWorldStage, IndoorStage or MainFieldDungeonStage):
***Wait for Tera to load<ref>tera読み込み待ち</ref>
*Step 8
**...{{check}}
**Wait for Tera to generate collision
**...{{check}}
*Step 9
**Initialize [[QuestMgr]].
**'''Set loading progress to 60%.'''
*Step 10
**Load stage specific resources<ref>ステージ固有リソースの読み込み待ち</ref>: if the binder type is StageBinderType::Title (3), the Title layout archive is loaded by [[LayoutResourceMgr]]. Otherwise, nothing happens.
*Step 11
**[[#Stage generation step 11]]
**Update player saved position, map type, map name, ...
**Change GameScene state to StageSelect or StageMgr (step 11-6 sets the state pointer to StageMgr).
**Terrain stuff{{check}}
**DungeonPackMgr: clean up state (destroy arena and heap) and unregister entry factory.
**Set flag 0xa25 (genStageStep12Reached?{{check}}) on the Fade screen instance.
**Stop resource compaction and set some flags on the TextureHandleMgr.
*Step 12
**Set aoc2 flag 0x4 if <code>isNewSave || !isShrine || isStageDebug</code> and clear it otherwise.
**[[#Stage generation step 12]]
**Terrain stuff again{{check}}
*Step 13 (final)
**[[#Stage generation final step]]
**Various flags are set upon completion, for example GameScene stage status is set to 0, isInitializingStage is set to false, etc.
**FadeProgress is reset.
**Stage generation debug timer is stopped.
**aoc2: IsLastPlayHardMode is updated.
**GameScene::sNeedsOptionLoad is set to true.

===Stage generation step 11===

*Step 0: init before stage gen (ステージ生成前の初期化処理)<ref>The function can be found at 0x71007B15A8 in Switch 1.5.0.</ref>
**Various flags are set (GameScene, BaseProcMgr, Awareness, EventMgr), in particular field 0x1d12a is set to true if <code>!isNewSave</code>.
**Set initial position based on the stage binder. This may be overridden with a saved position or an event position later on.
**GameSceneSubsys2, ActorSystem: set some flags
**GameSceneSubsys14: Update current location name (game data flag: SaveLocationName). The flag is written to if the player is in a shrine or a Divine Beast. Otherwise, it's read.
**PhysicsMemSys: set indoor flag if the stage binder type is Indoor (1)
**aoc2: Set flag 0x1 (IsLastPlayHardMode) if the corresponding game data flag is set. This is what the rest of the game uses to determine if Master Mode is enabled.
**Effect, Reaction, PhysicsMemSys, EventMgr
**PlacementMgr, LODMgr, EventMgr, WorldMgr, Awareness, Effect, XLink, VFR
**aocManager: set latest version played and HasAocVer{1,2,3} flags.
**Terrain
**Initialize the sound system and the UI manager
**If the stage binder type is OpenWorld (0) or the map name is ActorViewer or the current stage is a debug map:
***Create the HorseMgr instance, initialize it and create the horse actor.
***Create the WolfLinkMgr instance and initialize it.
***Create the MotorcycleMgr instance and initialize it.
**GameSceneSubsys5, GameSceneSubsys4: ? {{check}}
**If a flag is set (GameScene @ 0x6e5), SaveSystem::startLoad is called.
**TipsMgr: Initialize the TipsSystemActor.
*Step 1: wait for horse generation (馬の生成待ち)
*Step 2: if the stage binder type is not Title and not Viewer and not StartupSaveCheck, initialize PauseMenuDataMgr (PauseMenuDataMgr::fromSaveData).
*Step 3: wait for player equipment actor generation to complete (プレイヤーの装備アクターの生成完了待ち): CreatePlayerEquipActorMgr
*Step 4
**aocManager: parse MainField static map unit (if aocManager exists)
**Something involving vectors and calculations{{check}}
*Step 5
**Update FadeProgress based on the queue size of the BaseProcMgr actor create initializer{{check}} and PlacementMgr load progress{{check}}. This step represents the '''last 40% of the progress bar'''.
**Start [[#Stage generation step 11-5b]] as an async task<ref>0x71007B2C78</ref> and wait for it to complete.
**Stop the Fade screen "color animator".
**Call this->stage->initForStageGen (vtable @ 0x60). For most stages, this calls WorldMgr's SkyMgr::update.
**Graphics, uiManager, agl::lyr::Renderer: ?{{check}}
**Set this->activeStageBinder (@ 0x2a0) to this->stageBinder (@ 0x2a8)<ref>0x71007B1A88</ref>.
*Step 6
**Set next GameScene state to StageMgr.
**qword_71025D16C0: ?{{check}}
**If the binder type is Title (3):
***If the ROM type is "RID_Demo": reset some internal state in SaveMgr and SaveSystem.
***If aoc3 is initialized, set Blight rematch counters to 0 for all four blights.
**PauseMenuDataMgr: Update IsOpenItemCategory flags if necessary.
*Step 7: wait for save data upload to finish (if an upload is in progress).
*Step 8: BaseProcMgr: wait for some actor create initializer event and reset it{{check}}

====Stage generation step 11-5b====

*ProductReporter: reset scene work time (the amount of time since the last scene generation) and reset the blood moon reporter.
*Destroy the previous stage binder (this->activeStageBinder) if it's different from the current binder (this->stageBinder), and also set this->stage to nullptr.
*''Set the scene change event flow and entry point names'':
**If the binder type is Title: Demo025_2<Demo025_2>
**If aocManager::sInstance->version >= 0x200 and !100enemy_Activated and IsGet_Weapon_Sword_070 and !IsPlayed_Demo146_0:
***If the current [[map area]] is 14 (Korok Forest):
****If [[BalladOfHeroActiveTiming]] is 1: Aoc2Resident<InForrest>
****If [[BalladOfHeroActiveTiming]] is 0: Demo201_0<Demo201_0>
***Otherwise:
****If [[BalladOfHeroActiveTiming]] is 2: Aoc2Resident<InShrineOfResurrection>
****If [[BalladOfHeroActiveTiming]] is 1: Aoc2Resident<InOtherArea>
****If [[BalladOfHeroActiveTiming]] is 0: Demo200_0<Demo200_0>
**Otherwise, if the map type is MainField:
***If [[BalladOfHeroActiveTiming]] is 2: Demo600_1<Demo600_1>
***If [[BalladOfHeroActiveTiming]] is 1: Demo600_1<Demo600_0>
***Otherwise: Demo025_0<Demo025_0>
**If the map type is CDungeon or MarioClubTestDungeon: Demo008_2<Demo008_2>
*WorldMgr ShootingStarMgr: Update the isMainField flag.
*AmiiboMgr: Set flag 0x40 if the map name is MainField, otherwise clear it.
*'''Create the stage'''<ref>0x71007B3C5C</ref>.
**The stage class is automatically selected based on the stage binder type.
**stage->init and stage->postInit are called here<ref>0x71007CC024</ref>.

===Stage generation step 12===

*Step 0:
**[1.4.0+] If BalladOfHeroes_Step02 is false or BalladOfHeroes_Step03 is true, and if the player's equipped weapon (category 0) is Weapon_Sword_502 (One-Hit Obliterator), that weapon is removed from the inventory.
**'''FadeProgress is set to 100%'''.
*Step 1: Wait for environment map, grass, etc. (環境マップや草などの準備待ち) and set various flags (GameScene globals, Fade, BaseProcMgr).
*Step 2: Wait for 3 game ticks.
*Step 3: Terrain stuff{{check}}
*Step 4: ?{{check}}
*Step 5: Call the scene start event flow.
*Step 6:
**Wait for the scene start event flow (シーン開始イベントスタート待ち)
**Set some flags (Player, WorldMgr, PlacementMgr, ActorSystem)

===Stage generation final step===

*Sound, qword_71025D04F0, qword_71025D16C0, qword_71025D1740: ? {{check}}
*Clear the temporary stage binder pointer (which was used only during generation).
*Close the Fade and the FadeStatus screens. This effectively hides the loading screen.
*TipsMgr: TipsSystemActor is reset and the current date is stored.
*In dev mode, write a list of all loaded resources to %PROJECT_ROOT%/Log/BootupPatrol/res_title.csv.
*If the active stage binder type is Title (3) and resident actors haven't been loaded yet, start title background processing.
*Clear the "has played awakening demo" flag (not the game data flag!) if there is no active event or if the active event is not Demo169_0.
*Set this->stageGenerated to 1<ref>0x71007B2038</ref>.

==References==
<references />
[[Category:Internals]]
[[Category:Subsystems (BotW)]]

WorldMgr

2021-04-30T15:37:30Z

NiceneNerd: Added Wii U init address

<languages/>

{{Subsystem infobox|name=WorldMgr|init_addr_switch150=00000071010F2920|init_addr_wiiu150=03672220|is_name_official=1|description=Manages world state (time, blood moons, climates, weather, etc.)}}

<translate>

The '''World Manager''' (WorldMgr) is responsible for managing time, blood moons, climates, weather, fog, wind, lighting, procedural generation of clouds, whether the Lord of the Mountain appears, etc.


Because of the massive amount of state to handle, functionality is split across the main WorldMgr and 9 sub-managers.

== WorldMgr == 

=== Sub-managers === 
Sub-managers are created in WorldMgr::init (0x71010F43C0) and inserted into a pointer array (@WorldMgr+0x5c0). All names below are unofficial.
</translate>


{|class="wikitable"
|+ <translate> Sub-managers by ID</translate>
! <translate> ID</translate> !! <translate> Description</translate>
|-
| 0 || <translate> TimeMgr: Handles time, blood moons, Lord of the Mountain.</translate>
|-
| 1 || <translate> CloudPrMgr: Handles cloud procedural generation.</translate>
|-
| 2 || <translate> ShootingStarMgr: Manages shooting stars and (in 1.3.3+) special shooting stars for the Xenoblade 2 quest.</translate>
|-
| 3 || <translate> WeatherMgr: Handles "rain splash" and climate weathers.</translate>
|-
| 4 || <translate> TempMgr: Handles world temperature{{check}}.</translate>
|-
| 5 || ?
|-
| 6 || <translate> SkyMgr: Handles sky and fog{{check}}. Holds the configuration for all EnvPalettes, EnvAttributes, WeatherInfluences, Remains palettes, Indoor palettes and dungeon fogs.</translate>
|-
| 7 || <translate> DofMgr: Handles depth of field{{check}}. Holds depth of field related parameters.</translate>
|-
| 8 || ?
|}

<translate>
=== Climate === 
The main WorldMgr class is responsible for keeping climate related parameters and determining which set of climate settings to use. Strangely enough, WorldMgr uses the position of the Camera actor to figure out which map area the player is in (and thus what climate to use), not the Player actor.

== TimeMgr == 
TimeMgr handles everything to do with time, including Blood Moons and the Lord of the Mountain's apparition.


Internally, time of day is stored as a float in the [0.0, 360.0] range.
0.0 = midnight = 360.0; 90 ≈ morning; 180.0 = noon; and so on.

=== TimeMgr::init === 
* Time is set to 78.75 (05:15).
* Time for TotS environment is set to 78.75 (05:15) as well.
* "Bloody Moon end reserve timer" is set to 0.

=== TimeMgr::reset === 
This is called whenever a stage is unloaded (essentially every time the loading screen is shown when loading a different kind of stage -- e.g. shrine → overworld, but not shrine → shrine or overworld → overworld).
* Blood Moon checks are delayed.
* The AnimalMaster_Appearance flag is cleared, meaning the Lord of the Mountain will not appear.

=== TimeMgr::calc === 
This is called every frame.


* (If field 0x14A is set to 99, WM_BloodyDay is set to true. [[AIDef:Action/SetBloodyMoonEnv]] uses this to force a Blood Moon to be scheduled. This feature appears to be unused.)
* If both [[Demo]]103_0 and Demo997_0 have not been played, time of day is reset to 78.75 (05:15).
** Demo103_0 is the "leaving Shrine of Resurrection" cutscene, and Demo997_0 is a cutscene that doesn't exist anymore.
* If [[AIDef:Action/AdvanceTime]] or anything else that changes time of day was called, the actual time is updated at this moment.
* The game then performs [[#Midnight checks]].


* '''Update time of day''': there are several possible update modes. In most cases, the update mode is 0.
</translate>
{|class="wikitable"
! <translate> Mode</translate> !! <translate> Description</translate>
|-
| 0 || <translate>

If Demo103_0 or Demo997_0 have been played, and if there is no active event (cutscene):
* Add (0.0083333 * elapsed frames) to the Time of Day timer. Effectively, this means that 1 in-game minute = 1 real-life second.
* If the timer is >= 360.0, which means that a day has passed, the game subtracts 360 from the timer and then performs midnight checks.
* If FindDungeon_Activated is false (if the player hasn't received the ''The Isolated Plateau'' quest) and if the current time is >= 165.0 (11:00), the time is forcefully set to 11:00. Effectively, this means that time will not get past 11:00 until the Great Plateau Tower is activated and the Old Man cutscene is triggered.
* The Blood Moon timer is updated too.
</translate>
|-
| 1, 13, 35 || <translate> Freeze time to 04:00</translate>
|-
| 2, 14 || <translate> Freeze time to 05:00</translate>
|-
| 3, 16, 36 || <translate> Freeze time to 07:00</translate>
|-
| 4, 19, 37 || <translate> Freeze time to 10:00</translate>
|-
| 5, 26, 39 || <translate> Freeze time to 17:00</translate>
|-
| 6, 28, 40 || <translate> Freeze time to 19:00</translate>
|-
| 7, 30, 41 || <translate> Freeze time to 21:00</translate>
|-
| 8, 11 || <translate> Freeze time to 02:00</translate>
|-
| 9, 42 || <translate> Freeze time to 00:00</translate>
|-
| 10 || <translate> Freeze time to 01:00</translate>
|-
| 12 || <translate> Freeze time to 03:00</translate>
|-
| 15 || <translate> Freeze time to 06:00</translate>
|-
| 17 || <translate> Freeze time to 08:00</translate>
|-
| 18 || <translate> Freeze time to 09:00</translate>
|-
| 20 || <translate> Freeze time to 11:00</translate>
|-
| 21 || <translate> Freeze time to 12:00</translate>
|-
| 22, 38 || <translate> Freeze time to 13:00</translate>
|-
| 23 || <translate> Freeze time to 14:00</translate>
|-
| 24 || <translate> Freeze time to 15:00</translate>
|-
| 25 || <translate> Freeze time to 16:00</translate>
|-
| 27 || <translate> Freeze time to 18:00</translate>
|-
| 29 || <translate> Freeze time to 20:00</translate>
|-
| 31 || <translate> Freeze time to 22:00</translate>
|-
| 32 || <translate> Freeze time to 23:00</translate>
|-
| 34 ||<translate>

* Add (0.0083333 * elapsed frames) to the Time of Day timer.
* If the timer is >= 360.0, which means that a day has passed, the game subtracts 360 from the timer.


'''Note''': In this state, the blood moon timer is never updated and its value is never checked either.
</translate>
|}
<translate>

* Update the [[#Day/night time flag]], the [[#Time division, IsMorning, IsNoon, etc.]]
* If the "Bloody Moon end reserve timer" is non zero, decrement it. If the new value is zero, the WM_BloodyDay flag is cleared.
* Update [[#Lord of the Mountain]] flags.

=== Midnight checks === 
The following actions happen every time the timer reaches 360.0 (midnight).


WM_NumberOfDays is incremented.


'''If a Blood Moon is scheduled''' (WM_BloodyDay is true):
*If Blood Moons are prohibited (see conditions below), set the Blood Moon timer to 2880.0.
*If they are allowed to happen, call [https://eventviewer.zeldamods.org/viewer.html?data=/d/Demo011_0.json&params=1 Demo011_0] and set the Blood Moon timer to 0.0.


'''Scheduling new Blood Moons''':
*If the FirstTouchdown flag is set (i.e. if the player has left the Great Plateau), and if the Blood Moon timer is > 2520.0 (7 in-game days):
**WM_BloodyDay is set to true, which means that a Blood Moon is scheduled for the next night.
**The Blood Moon timer is reset to 0.0.
* Otherwise, the "Bloody end reserve timer" is set to 150. This ensures that the WM_BloodyDay flag is cleared 5 in-game minutes (= 5 seconds in real life) after a Blood Moon occurs.

==== Blood Moon inhibitors ==== 
If any of the following conditions are true, the Blood Moon cutscene will not be triggered.


* Not on MainField (main overworld)
* IsInHyruleCastleArea is set
* LastBossGanonBeastGenerateFlag is set (fighting Dark Beast Ganon)
* BloodyMoonProhibition is set
* Wind_Relic_BattleStart is set (Vah Medoh battle)
* Electric_Relic_Battle is set (Vah Naboris battle)
* Water_Relic_BattleTime is set (Vah Ruta battle)
* SkyMgr's field_2B4 is set to 15 and field_2B8 >= 1.0


However, these do not prevent the Blood Moon timer from advancing, or the WM_BloodyDay flag from being set.


Note: Vah Rudania is missing from the list. This is normal: blood moons cannot happen during the Vah Rudania battle sequence because the BloodyMoonProhibition flag is not set.

=== Day/night time flag === 
From 00:00 to 06:00 (closed interval) and from 18:00 to 00:00 (closed interval), WM_DaytimeFlag is set to false and WM_NighttimeFlag is true.


In any other case, WM_DaytimeFlag is set to true and WM_NighttimeFlag to false.
</translate>

=== Time division, IsMorning, IsNoon, etc. === 
{|class="wikitable"
! <translate> Start</translate> !! <translate> End</translate> !! Division !! Time type (1) !! Time type (2)
|-
| 04:00 || 05:00 || 0 || MorningA || Morning_A1
|-
| 05:00 || 07:00 || 0 || MorningA || Morning_A2
|-
| 07:00 || 10:00 || 1 || MorningB || Morning_B
|-
| 10:00 || 13:00 || 2 || NoonA || Noon_A
|-
| 13:00 || 17:00 || 3 || NoonB || Noon_B
|-
| 17:00 || 19:00 || 4 || EveningA || Evening_A
|-
| 19:00 || 21:00 || 5 || EveningB || Evening_B
|-
| 21:00 || 00:00 || 6 || NightA || Night_A
|-
| 00:00 || 04:00 || 7 || NightB || Night_B
|}

<translate>

Note: all intervals include the start time and exclude the end time.

=== Moon type === 
The moon type is calculated based on the number of in-game days (WM_NumberOfDays). The exact formula is <code>(numberOfDays + x + 1) % 8</code><ref>0x71010E8200</ref>, where x is equal to 1 if the current time is > 180.0 (noon) and % is the modulo operator.


If a moon type was set manually (for instance using [[AIDef:Action/EventSetMoonType]]), that value will be used as the moon type.


The moon type is returned by [[AIDef:Query/WhatMoonName]], which some NPC event flows use to check the current moon phase. However, the moon schedule has nothing to do with the blood moon schedule.

=== Lord of the Mountain === 
The Lord of the Mountain appears whenever the AnimalMaster_Appearance flag is set. Its value is managed by a simple state machine.


Note that whenever a stage is unloaded, the AnimalMaster_Appearance flag is reset to false.

====State 0 - Wait for conditions==== 
If the following three conditions are true:
* The [[#Moon type]] is 5 (waxing crescent)
* The AnimalMaster_Existence flag is false (the LotM must not already be spawned)
* The current [[map area]] number is not 64 ("HyruleHill", presumably the Satori Mountain area)


then the game generates a random "appearance hour" in the [0 .. 22] interval and goes into state 1.

====State 1 - Wait for the appearance time==== 
If the player is in map area 64, the state is reset back to 0.


Otherwise, the game does nothing until the current hour matches the previously generated appearance hour, at which point it sets AnimalMaster_Appearance to true (which allows the LotM to spawn) and goes into state 2.

====State 2 - Satori Mountain is glowing==== 
After one hour has elapsed, the current day of the week is stored and the state is set to 3.

====State 3 - Prepare to despawn==== 
After two week day changes, ''or'' [after the in-game day of the week changes and the current hour is >= the generated appearance hour], the LotM will disappear and the state will be set to 4.

====State 4 - Despawned==== 
The game waits for the moon type to be 5, before going back to state 0.

== WeatherMgr == 
{{expand section}}
=== Weather types ===
</translate>
{|class="wikitable"
! <translate> Value</translate> !! <translate> Name</translate>
|-
| 0 || Bluesky
|-
| 1 || Cloudy
|-
| 2 || Rain
|-
| 3 || HeavyRain
|-
| 4 || Snow
|-
| 5 || HeavySnow
|-
| 6 || ThunderStorm
|-
| 7 || ThunderRain
|-
| 8 || BlueskyRain
|}


[[Category:Internals{{#translation:}}]]
[[Category:Subsystems (BotW){{#translation:}}]]

Subsystems

2021-04-30T15:11:31Z

NiceneNerd: Show Wii U init addresses

The game code is organised into '''subsystems''', each responsible for one technical aspect of the game. Each subsystem is typically a singleton.

Note: the following list does not include external libraries. It is also likely to be incomplete.

{{#dpl:
|category=Subsystems (BotW)
|ordermethod=titlewithoutnamespace
|includepage ={Subsystem infobox}:name:is_name_official:init_addr_switch150:init_addr_wiiu150:description
|table=width=100% class="wikitable sortable",-,Name,Official name,Init (Switch 1.5.0),Init (Wii U 1.5.0),Description
|tablerow=[[%PAGE%|%%]],²{#ifexpr:%%{{!}}Yes{{!}}No}²,%%,%%
}}

[[Category:Internals]]

UiManager

2021-04-30T14:46:06Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=uiManager|is_name_official=1|description=-|init_addr_switch150=0000007100A6E038|init_addr_wiiu150=0304A620}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

StasisMgr

2021-04-30T14:43:26Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=StasisMgr|is_name_official=0|description=Unknown, initialised from GameScene code. Handles Stasis effects (vector arrow, sound, etc.) and more|init_addr_switch150=000000710067F3A8|init_addr_wiiu150=02A3bC08}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

ResidentActorMgr

2021-04-30T14:41:00Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=ResidentActorMgr|is_name_official=1|description=Creates and manages actors that are always kept in memory such as GameROMPlayer|init_addr_switch150=000000710090E0A0|init_addr_wiiu150=02E38C4C}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

Resetter

2021-04-30T14:39:16Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=Resetter|is_name_official=0|description=Initialised from GameScene code - Handles game system resets.|init_addr_switch150=00000071007D20A0|init_addr_wiiu150=02C58148}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

PlayerResetPosMgr

2021-04-30T14:34:31Z

NiceneNerd:

{{Subsystem infobox|name=PlayerResetPosMgr|is_name_official=0|description=Manages player reset positions|init_addr_switch150=00000071007A5CA8|init_addr_wiiu150=02C1E338}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

PlayerResetPosMgr

2021-04-30T14:34:18Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=PlayerResetPosMgr|is_name_official=0|description=Manages player reset positions|init_addr_switch150=00000071007A5CA8|init_addr_wiiu150=02c1e338}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

RuneMgr

2021-04-12T23:41:10Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=RuneMgr|is_name_official=0|description=Initialised from GameScene code. Related to Sheikah Slate functionality (spawning bombs, scope, runes).|init_addr_switch150=0000007100674F78|init_addr_wiiu150=02A2C034}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

ActorLimiter

2021-04-12T23:39:39Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=ActorLimiter|is_name_official=0|description=Limits the number of spawned actors (e.g. for amiibo drops)|init_addr_switch150=0000007100E4D770|init_addr_wiiu150=032C34A8}}

'''ActorLimiter''' is a subsystem that makes it possible to artificially limit the number of spawned actors in some cases (e.g. for amiibo drops or enemy drops).

ActorLimiter is initialised from [[GameScene]].

== How it works ==

When an actor is spawned, it can be manually added to an ActorLimiter list. The add function checks whether the actor list is full and deletes an existing actor if needed.

Actors with the PriorityMaterial [[actor tag]] are not discarded.

== Lists ==

In 1.5.0, there are 8 different lists<ref>{{addr|a=0x71007A8308|ver=nx-1.5.0}}</ref>.

{|class="wikitable"
! Index || Description !! Number of actors
|-
| 0 || Lumberjack tree drops{{check}}
| 10
|-
| 1 || Dropped items (except weapons) or InCarryBox actors{{check}}
| 10
|-
| 2 || "Player trash" (dropped weapons)
| 10
|-
| 3 || Drops || 20
|-
| 4 || Sand seal (Animal_SunazarashiSP_A) || 1
|-
| 5 || [[Bullet]]s || 10
|-
| 6 || [[amiibo drops]] || 15
|-
| 7 || ? || 10
|}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

CookingMgr

2021-04-12T23:28:38Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=CookingMgr|is_name_official=1|description=Determines which cook item should be returned for a given set of ingredients.|init_addr_switch150=000000710089FFC8|init_addr_wiiu150=02DB60B8}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

DamageInfoMgr

2021-04-12T23:24:49Z

NiceneNerd:

{{Subsystem infobox|name=DamageInfoMgr|is_name_official=1|description=Unknown, initialised from GameScene code. Stores plenty of BaseProcLinks.|init_addr_switch150=000000710067170C|init_addr_wiiu150=02A29C14}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

DamageInfoMgr

2021-04-12T23:24:36Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=DamageInfoMgr|is_name_official=1|description=Unknown, initialised from GameScene code. Stores plenty of BaseProcLinks.|init_addr_switch150=000000710067170C|init_addr_wiiu=02A29C14}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

WolfLinkMgr

2021-04-11T21:32:03Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=WolfLinkMgr|is_name_official=0|description=Handles Wolf Link related tasks|init_addr_switch150=00000071006828A8|init_addr_wiiu150=02A3ED90}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

PlayerInfo

2021-04-09T11:29:14Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=PlayerInfo|is_name_official=0|description=Holds information about the player (position, heart, stamina, etc.)|init_addr_switch150=0000007100854298|init_addr_wiiu150=02D495D8}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

DungeonPackMgr

2021-04-09T11:28:04Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=DungeonPackMgr|is_name_official=1|description=Handles dungeon pack loading when changing stages.|init_addr_switch150=00000071008A559C|init_addr_wiiu150=02DBDBCC}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

FadeProgress

2021-04-09T11:27:10Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=FadeProgress|is_name_official=0|description=Initialised from GameScene code - Updates the progress gauge on the loading screen ("Fade").|init_addr_switch150=00000071007CBA28|init_addr_wiiu150=02C4F6E4}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

AutoPlacementFlowMgr

2021-04-09T11:25:32Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=AutoPlacementFlowMgr|is_name_official=1|description=Runs event flow files to determine which actors to spawn on the map dynamically|init_addr_switch150=0000007100651F94|init_addr_wiiu150=029F976C}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

IceBlockMgr

2021-04-08T18:46:37Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=IceBlockMgr|is_name_official=0|description=-|init_addr_switch150=000000710066E984|init_addr_wiiu150=02A22378}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

DropMgr

2021-04-08T18:38:41Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=DropMgr|is_name_official=0|description=Unknown, initialised from GameScene code. Responsible for spawning actor drops when they die|init_addr_switch150=0000007100D2B7C8|init_addr_wiiu150=0310B10C}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

AmiiboMgr

2021-04-08T18:03:21Z

NiceneNerd:

{{Subsystem infobox|name=AmiiboMgr|is_name_official=1|description=Handles amiibo functionality|init_addr_switch150=00000071006488A8|init_addr_wiiu150=029E58FC}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

AmiiboMgr

2021-04-08T18:02:42Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=AmiiboMgr|is_name_official=1|description=Handles amiibo functionality|init_addr_switch150=00000071006488A8|addr_wiiu_150=029E58FC}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

PauseMenuDataMgr

2021-04-08T12:04:03Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=PauseMenuDataMgr|is_name_official=1|description=Handles player inventory and equipment synchronization.|init_addr_switch150=000000710096B1CC|init_addr_wiiu150=02EADFDC}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

SaveMgr

2021-04-08T02:58:18Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=SaveMgr|is_name_official=1|description=Loads game data into GameDataMgr or writes it to saves.|init_addr_switch150=0000007100E03214|init_addr_wiiu150=0324E6AC}}
{{stub}}

== savedataformat loading ==
Similarly to GameDataMgr, SaveMgr loads every file that is in the [[savedataformat]] archive and assumes it is a [[bgsvdata]] resource<ref>SaveMgr code: 0x7100E0EE24</ref>. The file name does not matter.

SaveMgr can only load up to 0x20 files<ref>SaveMgr code: 0x7100E0EE50</ref>.

For each file, one Bgsvdata resource object is created and save information is loaded from the resource. SaveMgr only supports a single file entry in the "file_list"<ref>Bgsvdata resource code: 0x710127B060</ref>. The HashValue is ignored; the game always uses CRC32(DataName).

After all resources have been loaded, a different Bgsvdata resource object is created and internally populated with N file entries, where N is the number of distinct file_name values<ref>0x7100E0F22C</ref> in all previously loaded resources.

The flag array for each file in that Bgsvdata object is then sorted<ref>0x7100E0F270</ref><ref>0x710127B664</ref><ref>0x710127B6D4</ref><ref>0x710127BB5C</ref>{{check}}.

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

EventMgr

2021-04-08T02:25:36Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=EventMgr|is_name_official=1|description=Manages all in-game events ([[event flow]]s, [[demo]]s, etc.)|init_addr_switch150=0000007100DAF3D8|init_addr_wiiu150=031C8D5C}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

QuestMgr

2021-04-08T02:17:39Z

NiceneNerd: Added Wii U init address

{{Subsystem infobox|name=QuestMgr|is_name_official=1|description=Holds information about game quests and steps. Interacts with GameDataMgr.|init_addr_switch150=0000007100FD5770|init_addr_wiiu150=034E0AB0}}
{{stub}}

[[Category: Internals]]
[[Category: Subsystems (BotW)]]

Help:Dumping games

2020-12-08T22:55:26Z

NiceneNerd: Add a tiny bit of structure

In order to get a copy of the [[content]] files and [[executable]], you will need to dump ''Breath of the Wild'' from a console. This article provides instructions for Wii U and Switch users.

== Wii U ==
The easiest method for dumping BOTW in a manner compatible with tools like Cemu and BCML is to use Dumpling.

=== Prerequisites ===
* BOTW 1.5.0 on your Wii U
* Modded Wii U with Homebrew Launcher

=== Dumping your game files ===
# Download the latest release of Dumpling from [https://github.com/emiyl/dumpling/releases here].
# Extract the ZIP to the root of your SD card.
# Before running Dumpling, disable auto power off and standby on your Wii U.
# Insert any USB devices or game discs you’d like to use in the dump process.
# Open Dumpling from the Homebrew Launcher.
# Select "Dump digital games" or "Dump a game disc" as appropriate.
# Select BOTW using the (A) button and then press (START) (selection N/A if using a disc). Make sure to check the boxes for base game, update, and (if applicable) DLC.
# Set the dump destination.
# Select (START) to begin dumping (which can take a ''very'' long time).
# Once finished, you can put the SD card into your PC and, if desired, copy the files onto your hard drive for use with modding tools or whatever else.

== Switch ==
Dump the game files directly to your SD card using nxdumptool. Update data can only be processed if the base game is available, because they share the same filesystem. DLCs don't, so they have to be dumped separately.

'''Warning''': Running homebrew on the Switch can get you banned from Nintendo online services if you aren't careful. If you do not want to leave any traces, turn on airplane mode, back up your eMMC '''before running any homebrew''' and do not ever go online before you have restored the backup.

=== Prerequisites ===
* [https://github.com/DarkMatterCore/nxdumptool nxdumptool].
* Keys file generated using [https://github.com/shchmue/Lockpick_RCM Lockpick_RCM], located at <code>sdmc:/switch/prod.keys</code>. Run the payload on your console through RCM in order to dump the keys needed by nxdumptool to decrypt contents.

=== Dumping game files ===
* On your Switch, open nxdumptool. Afterwards:
*# '''If you have the gamecard''': Select <code>Dump gamecard content</code>.
*# '''If you have the eShop version''': Select <code>Dump SD card / eMMC content</code>, then select BotW.
* Select <code>RomFS options</code>.
* Highlight the <code>Use update/DLC</code> option and use the left/right buttons to cycle through the available updates/DLCs for the game.
*# '''If you have no available updates/DLCs''', this option won't appear. You'll only be able to dump the files from the non-updated base game (which is the same to just leaving this option set to <code>No</code>).
*# Updates are tagged as <code>(UPD)</code>, and they use <code>01007EF00011E800</code> as their ID. v786432 corresponds to BotW v1.6.0 update.
*# DLCs are tagged as <code>(DLC)</code>. <code>01007EF00011F001</code> and <code>01007EF00011F002</code> are the known IDs for the existent BotW DLCs.
* Select <code>RomFS section data dump</code> and wait for the process to finish. This will dump the internal filesystem from the selected update/DLC to the inserted SD card.

Just like it was previously mentioned, updates share their filesystem data with the base game, so dumping the RomFS from an update is equivalent to dumping the whole filesystem from the updated game data. In other words, it isn't necessary to dump the base game filesystem separately if you choose an update.

DLCs, on the other hand, must be dumped separately.

When you're done, you'll be able to find the output dumps in <code>sdmc:/switch/nxdumptool/RomFS</code>.

=== Dumping binaries (executable files) ===
Executables in Switch titles are stored in a different section known as the ExeFS, which is only available in base games and updates. Unlike RomFS data, ExeFS data isn't shared between the update and its base game.

These files can also be dumped using nxdumptool.

* On your Switch, open nxdumptool. Afterwards:
*# '''If you have the gamecard''': Select <code>Dump gamecard content</code>.
*# '''If you have the eShop version''': Select <code>Dump SD card / eMMC content</code>, then select BotW.
* Select <code>ExeFS options</code>.
* Highlight the <code>Use update</code> option and use the left/right buttons to cycle through the available updates for the game.
*# '''If you have no available updates''', this option won't appear. You'll only be able to dump the binaries from the non-updated base game (which is the same to just leaving this option set to <code>No</code>).
*# Updates use <code>01007EF00011E800</code> as their ID. v786432 corresponds to BotW v1.6.0 update.
* Select <code>ExeFS section data dump</code> and wait for the process to finish. This will dump the binaries from the selected update to the inserted SD card.

When you're done, you'll be able to find the output dump in <code>sdmc:/switch/nxdumptool/ExeFS</code>.

Help:Dumping games

2020-12-08T22:53:09Z

NiceneNerd: Expand Wii U dump tutorial and switch from ddd to Dumpling

In order to get a copy of the [[content]] files and [[executable]], you will need to dump ''Breath of the Wild'' from a console. This article provides instructions for Wii U and Switch users.

== Wii U ==
The easiest method for dumping BOTW in a manner compatible with tools like Cemu and BCML is to use Dumpling.

# Download the latest release of Dumpling from [https://github.com/emiyl/dumpling/releases here].
# Extract the ZIP to the root of your SD card.
# Before running Dumpling, disable auto power off and standby on your Wii U.
# Insert any USB devices or game discs you’d like to use in the dump process.
# Open Dumpling from the Homebrew Launcher.
# Select "Dump digital games" or "Dump a game disc" as appropriate.
# Select BOTW using the (A) button and then press (START) (selection N/A if using a disc). Make sure to check the boxes for base game, update, and (if applicable) DLC.
# Set the dump destination.
# Select (START) to begin dumping (which can take a ''very'' long time).
# Once finished, you can put the SD card into your PC and, if desired, copy the files onto your hard drive for use with modding tools or whatever else.

== Switch ==
Dump the game files directly to your SD card using nxdumptool. Update data can only be processed if the base game is available, because they share the same filesystem. DLCs don't, so they have to be dumped separately.

'''Warning''': Running homebrew on the Switch can get you banned from Nintendo online services if you aren't careful. If you do not want to leave any traces, turn on airplane mode, back up your eMMC '''before running any homebrew''' and do not ever go online before you have restored the backup.

=== Prerequisites ===
* [https://github.com/DarkMatterCore/nxdumptool nxdumptool].
* Keys file generated using [https://github.com/shchmue/Lockpick_RCM Lockpick_RCM], located at <code>sdmc:/switch/prod.keys</code>. Run the payload on your console through RCM in order to dump the keys needed by nxdumptool to decrypt contents.

=== Dumping game files ===
* On your Switch, open nxdumptool. Afterwards:
*# '''If you have the gamecard''': Select <code>Dump gamecard content</code>.
*# '''If you have the eShop version''': Select <code>Dump SD card / eMMC content</code>, then select BotW.
* Select <code>RomFS options</code>.
* Highlight the <code>Use update/DLC</code> option and use the left/right buttons to cycle through the available updates/DLCs for the game.
*# '''If you have no available updates/DLCs''', this option won't appear. You'll only be able to dump the files from the non-updated base game (which is the same to just leaving this option set to <code>No</code>).
*# Updates are tagged as <code>(UPD)</code>, and they use <code>01007EF00011E800</code> as their ID. v786432 corresponds to BotW v1.6.0 update.
*# DLCs are tagged as <code>(DLC)</code>. <code>01007EF00011F001</code> and <code>01007EF00011F002</code> are the known IDs for the existent BotW DLCs.
* Select <code>RomFS section data dump</code> and wait for the process to finish. This will dump the internal filesystem from the selected update/DLC to the inserted SD card.

Just like it was previously mentioned, updates share their filesystem data with the base game, so dumping the RomFS from an update is equivalent to dumping the whole filesystem from the updated game data. In other words, it isn't necessary to dump the base game filesystem separately if you choose an update.

DLCs, on the other hand, must be dumped separately.

When you're done, you'll be able to find the output dumps in <code>sdmc:/switch/nxdumptool/RomFS</code>.

=== Dumping binaries (executable files) ===
Executables in Switch titles are stored in a different section known as the ExeFS, which is only available in base games and updates. Unlike RomFS data, ExeFS data isn't shared between the update and its base game.

These files can also be dumped using nxdumptool.

* On your Switch, open nxdumptool. Afterwards:
*# '''If you have the gamecard''': Select <code>Dump gamecard content</code>.
*# '''If you have the eShop version''': Select <code>Dump SD card / eMMC content</code>, then select BotW.
* Select <code>ExeFS options</code>.
* Highlight the <code>Use update</code> option and use the left/right buttons to cycle through the available updates for the game.
*# '''If you have no available updates''', this option won't appear. You'll only be able to dump the binaries from the non-updated base game (which is the same to just leaving this option set to <code>No</code>).
*# Updates use <code>01007EF00011E800</code> as their ID. v786432 corresponds to BotW v1.6.0 update.
* Select <code>ExeFS section data dump</code> and wait for the process to finish. This will dump the binaries from the selected update to the inserted SD card.

When you're done, you'll be able to find the output dump in <code>sdmc:/switch/nxdumptool/ExeFS</code>.

Help:Using mods

2020-12-08T22:37:35Z

NiceneNerd: Update information on using BCML

Welcome, players! This article will walk you through setting up BotW to play with mods. There are three different platforms you can play on:

* Wii U console
* Cemu, the Wii U emulator, on your computer
* Switch console

Almost all Wii U mods should work on both the console and Cemu, but most Switch mods aren't cross-compatible. In addition, many mods are only compatible with version 1.5.0 of BotW.

Note that any mods which edit any of the same files as each other will probably be incompatible and cause issues. Sometimes, mods that edit different files can also be unexpectedly incompatible. If you are using multiple mods and you find glitches, please figure out which mod / combination of mods is causing the issue before reporting it to the mod creator(s).

== Wii U Console ==

=== Setting up homebrew ===
Follow [https://wiiu.hacks.guide/ this guide] to set up your Wii U console to use homebrew software.

=== Setting up WUPS SDCafiine ===
SDCafiine is a Wii U homebrew program that will load modded game files from your SD card. The classic version has a history of serious stability problems, as the program eventually unloads from memory, and game files begin to revert to their unmodded state. An alternative version designed for the Wii U Plugin System (WUPS) is ''much'' more stable and does not usually unload, so it is recommended.

# Download the latest nightly release of the Wii U Plugin Loader from [https://github.com/Maschell/WiiUPluginLoader/releases here].
# Extract the contents of the .zip into the root of your SD card.
# Download the latest WUPS nightly of SDCafiine from [https://github.com/Maschell/SDCafiine/releases/tag/SDCafiine-WUPS-v1.4-nightly-67aa461 here].
# Extract the contents of the .zip into the root of your SD card.
# Create a new folder in the root of your SD Card, named <code>sdcafiine</code>.
# Within that folder, create a new folder with the name of your game's Title ID. On Wii U, the JP version of BotW uses <code>00050000101C9300</code>, the US version uses <code>00050000101C9400</code>, and the EU version uses <code>00050000101C9500</code>.
# Within that folder, you can create any number of folders named after the mods you want to use. When you boot the game, a menu will appear allowing you to select one to use.
# Inside each of those folders, create a folder named <code>content</code>. Your mod files will go in here. (Mods will often include a <code>content</code> folder already to make things clear. If using BCML, this is where you will put the contents of the exported BCML pack.)

To use mods:
# Run the Wii U Plugin Loader option from the Homebrew Launcher
# Tick the SDCafiine plugin on and press '''+''' to Apply Patches.
# Back at the Wii U menu, launch BOTW.
# If you have only one mod, it will load automatically. If there are multiple mods, you will be prompted to select one to use.

== Cemu Emulator ==

=== Download Cemu Emulator ===
You can find the latest version of Cemu Emulator on the [http://cemu.info/ Official Cemu Website]

=== Setting up homebrew ===
Follow [https://wiiu.hacks.guide/ this guide] to set up your Wii U console to use homebrew software, in order to allow you to dump the game files from your console to your PC.

=== Dumping the game files ===
To play BotW on Cemu, you'll need to [[Help:Dumping games|dump the game files]] from the console to your computer. Then run the <code>U-King.rpx</code> file from Cemu to boot the game.

=== Installing the DLC ===
If you dumped the game's add-on content (aoc) files, follow [http://compat.cemu.info/wiki/Tutorial:How_to_install_a_DLC this guide] to install them in Cemu.

=== Setting up and Maximising Performance ===
Now that you have Cemu and your games files, it is recommended you use [http://compat.cemu.info/wiki/Serfrosts_Cemu_Setup_Guide Serfrosts Cemu Setup Guide] to maximise performance on your hardware before installing mods.

=== Installing mods using BCML ===
Mods that are packaged as a graphic pack or as a BNP can be installed using [[Help:Tools/BCML|BCML]], a mod loading tool. In addition to being simpler than manually extracting and enabling the mod, BCML is designed to resolve certain kinds of conflicts between different mods. Mods that modify many types of content, including the [[RSTB]], the same [[SARC]] files, or [[Message archives]], among many others, will not function properly together unless the changes are merged. BCML does this automatically. To install mods with BCML:

# Install and setup BCML using the instructions [[Help:Tools/BCML#Setup|here]] or in [https://www.youtube.com/watch?v=g_EEtcqaQsg this video tutorial].
# Open BCML.
# Click the floating action button to install mods.

For more information on using BCML, see the [https://github.com/NiceneNerd/BCML/tree/master/docs BCML docs].

BCML should automatically enable installed mods in Cemu, but check to make sure by opening the Cemu graphic pack menu and making sure the "BCML" graphic pack under <code>The Legend of Zelda: Breath of the Wild/Mods/BCML</code> is enabled.

=== Installing mods with the graphic pack menu ===
Cemu uses "graphic packs" to install mods without overwriting any of the base files, allowing you to easily install or uninstall mods without leaving any trace.

Graphic packs are installed by placing the unzipped folder in <code>Cemu/graphicPacks/</code>. Note that most newer mods will come packaged as a graphic pack, or have a graphic pack option.

To check that the mod is a graphic pack, open the mod folder within <code>Cemu/graphicPacks/</code>. A graphic pack will have a file called <code>rules.txt</code> next to the <code>content</code> and/or <code>aoc</code> folder.

If a mod is not packaged as a graphic pack you will have to package it yourself, otherwise skip to the end of this section. This method works for versions of Cemu 1.15.1+

# Create a new folder inside <code>Cemu/graphicPacks/</code> named after the mod you want to use.
# Inside that folder, create a folder named <code>content</code>. Your mod files will go in here. (Mods will often include a <code>content</code> folder already to make things clear.)
# Create a file named <code>rules.txt</code> next to the <code>content</code> folder (if the downloaded mod doesn't already include one). Use this example as a template:

[Definition]
titleIds = 00050000101C9300,00050000101C9400,00050000101C9500
name = <Mod Name>
path = "The Legend of Zelda: Breath of the Wild/Mods/<Mod Name>"
description = <Mod description here>
version = 3
fsPriority = 100
<code>version</code> must be set to 3 to work correctly. <code>fsPriority</code> determines the order in which mods are prioritized - higher numbers prioritize that mod's files over other mods. Mods without an <code>fsPriority</code> entry specified will default to 100.

Once a mod has been added, simply enable it from Cemu's graphic pack menu to use it. You can find this menu in <code>Options > Graphic Packs</code> or by right-clicking a game and selecting <code>Edit Graphic Packs</code>.
Note that most mods should not be enabled or disabled while the game is running.

== Switch ==

=== Setting up homebrew ===
Follow [https://guide.sdsetup.com this guide] to set up your Switch console to use homebrew software.

This tutorial uses Atmosphère Custom Firmware (CFW). It is strongly recommended '''not''' to use other CFWs as they tend to be outdated, unsafe and/or use stolen code from Atmosphère.
{{warning|text=Running homebrew on your console may lead to it getting banned from Nintendo's online services (including eShop and game updates). Enabling Airplane Mode will not help, as telemetry reports are saved and sent to Nintendo the next time you connect to the internet.

However, this risk is very minimal as long as you are sensible and only use a safe, sane CFW (Atmosphère) and mods on offline games (don't install NSPs or pirate games!) as Atmosphère does not leave any trace on the system and disables some system telemetry.

If you are paranoid, turn on Airplane Mode ''before running homebrew for the first time'', then make a full system backup, and always stay offline until you restore that clean backup.}}

=== Disabling telemetry reports ===
The Switch version of ''Breath of the Wild'' sends many [[telemetry]] reports so when you are using mods that modify gameplay in a detectable way or add new content in any way, it is strongly recommended to disable telemetry reports because they are used by Zelda developers to understand how people play BotW and also to help them fix bugs.

Mods that modify actors are especially dangerous as they might cause the game to use the ActorSystem emergency heap and trigger many memory-related play reports.

To disable problematic telemetry reports:

* For 1.5.0, download this [http://static.zeldamods.org/patch_switch150_no_telemetry.ips patch], put it in <code>/atmosphere/exefs_patches/botw_no_telemetry/</code> (create new folders if required) and rename the file to <code>16A91992BBA71201E98756F3BC8F5D2F.ips</code>. This patch works for the Switch 1.5.0 [[executable]] only (build ID: 16A91992BBA71201E98756F3BC8F5D2F).

* For 1.6.0, download this [http://static.zeldamods.org/patch_switch160_no_telemetry.ips patch], put it at <code>/atmosphere/exefs_patches/botw_no_telemetry/</code> (create new folders if required) and rename the file to <code>8E9978D50BDD20B4C8395A106C27FFDE.ips</code>. This patch works for the Switch 1.6.0 [[executable]] only (build ID: 8E9978D50BDD20B4C8395A106C27FFDE).

=== Installing mods ===

# In the root of your MicroSD card, there should be a folder named <code>atmosphere</code>.
# Within that folder, there should be a folder named <code>contents</code>. Inside that, create a folder with the name of your game's Title ID. For BotW on Switch, the Title ID is <code>01007EF00011E000</code>. (In versions of Atmosphere prior to v0.10.0, the <code>contents</code> folder was instead called <code>titles</code>.)
# Inside that, make a folder called <code>romfs</code>. Your mod files will go in here. (Mods will often include all or part of this folder structure already, to make things easy.)

To use the mod, simply boot the console into CFW, then boot the game, and the mod will be active.

Note that mods are not permanently installed on the console. To remove all installed mods, simply delete <code>/atmosphere/contents/01007EF00011E000</code>.
[[Category:Guides]]

Help:Using mods

2020-12-08T22:31:20Z

NiceneNerd: /* Setting up WUPS SDCafiine */

Welcome, players! This article will walk you through setting up BotW to play with mods. There are three different platforms you can play on:

* Wii U console
* Cemu, the Wii U emulator, on your computer
* Switch console

Almost all Wii U mods should work on both the console and Cemu, but most Switch mods aren't cross-compatible. In addition, many mods are only compatible with version 1.5.0 of BotW.

Note that any mods which edit any of the same files as each other will probably be incompatible and cause issues. Sometimes, mods that edit different files can also be unexpectedly incompatible. If you are using multiple mods and you find glitches, please figure out which mod / combination of mods is causing the issue before reporting it to the mod creator(s).

== Wii U Console ==

=== Setting up homebrew ===
Follow [https://wiiu.hacks.guide/ this guide] to set up your Wii U console to use homebrew software.

=== Setting up WUPS SDCafiine ===
SDCafiine is a Wii U homebrew program that will load modded game files from your SD card. The classic version has a history of serious stability problems, as the program eventually unloads from memory, and game files begin to revert to their unmodded state. An alternative version designed for the Wii U Plugin System (WUPS) is ''much'' more stable and does not usually unload, so it is recommended.

# Download the latest nightly release of the Wii U Plugin Loader from [https://github.com/Maschell/WiiUPluginLoader/releases here].
# Extract the contents of the .zip into the root of your SD card.
# Download the latest WUPS nightly of SDCafiine from [https://github.com/Maschell/SDCafiine/releases/tag/SDCafiine-WUPS-v1.4-nightly-67aa461 here].
# Extract the contents of the .zip into the root of your SD card.
# Create a new folder in the root of your SD Card, named <code>sdcafiine</code>.
# Within that folder, create a new folder with the name of your game's Title ID. On Wii U, the JP version of BotW uses <code>00050000101C9300</code>, the US version uses <code>00050000101C9400</code>, and the EU version uses <code>00050000101C9500</code>.
# Within that folder, you can create any number of folders named after the mods you want to use. When you boot the game, a menu will appear allowing you to select one to use.
# Inside each of those folders, create a folder named <code>content</code>. Your mod files will go in here. (Mods will often include a <code>content</code> folder already to make things clear. If using BCML, this is where you will put the contents of the exported BCML pack.)

To use mods:
# Run the Wii U Plugin Loader option from the Homebrew Launcher
# Tick the SDCafiine plugin on and press '''+''' to Apply Patches.
# Back at the Wii U menu, launch BOTW.
# If you have only one mod, it will load automatically. If there are multiple mods, you will be prompted to select one to use.

== Cemu Emulator ==

=== Download Cemu Emulator ===
You can find the latest version of Cemu Emulator on the [http://cemu.info/ Official Cemu Website]

=== Setting up homebrew ===
Follow [https://wiiu.hacks.guide/ this guide] to set up your Wii U console to use homebrew software, in order to allow you to dump the game files from your console to your PC.

=== Dumping the game files ===
To play BotW on Cemu, you'll need to [[Help:Dumping games|dump the game files]] from the console to your computer. Then run the <code>U-King.rpx</code> file from Cemu to boot the game.

=== Installing the DLC ===
If you dumped the game's add-on content (aoc) files, follow [http://compat.cemu.info/wiki/Tutorial:How_to_install_a_DLC this guide] to install them in Cemu.

=== Setting up and Maximising Performance ===
Now that you have Cemu and your games files, it is recommended you use [http://compat.cemu.info/wiki/Serfrosts_Cemu_Setup_Guide Serfrosts Cemu Setup Guide] to maximise performance on your hardware before installing mods.

=== Installing mods with the graphic pack menu ===
Cemu uses "graphic packs" to install mods without overwriting any of the base files, allowing you to easily install or uninstall mods without leaving any trace.

Graphic packs are installed by placing the unzipped folder in <code>Cemu/graphicPacks/</code>. Note that most newer mods will come packaged as a graphic pack, or have a graphic pack option.

To check that the mod is a graphic pack, open the mod folder within <code>Cemu/graphicPacks/</code>. A graphic pack will have a file called <code>rules.txt</code> next to the <code>content</code> and/or <code>aoc</code> folder.

If a mod is not packaged as a graphic pack you will have to package it yourself, otherwise skip to the end of this section. This method works for versions of Cemu 1.15.1+

# Create a new folder inside <code>Cemu/graphicPacks/</code> named after the mod you want to use.
# Inside that folder, create a folder named <code>content</code>. Your mod files will go in here. (Mods will often include a <code>content</code> folder already to make things clear.)
# Create a file named <code>rules.txt</code> next to the <code>content</code> folder (if the downloaded mod doesn't already include one). Use this example as a template:

[Definition]
titleIds = 00050000101C9300,00050000101C9400,00050000101C9500
name = <Mod Name>
path = "The Legend of Zelda: Breath of the Wild/Mods/<Mod Name>"
description = <Mod description here>
version = 3
fsPriority = 100
<code>version</code> must be set to 3 to work correctly. <code>fsPriority</code> determines the order in which mods are prioritized - higher numbers prioritize that mod's files over other mods. Mods without an <code>fsPriority</code> entry specified will default to 100.

Once a mod has been added, simply enable it from Cemu's graphic pack menu to use it. You can find this menu in <code>Options > Graphic Packs</code> or by right-clicking a game and selecting <code>Edit Graphic Packs</code>.
Note that most mods should not be enabled or disabled while the game is running.

=== Installing mods using BCML ===
Mods that are already packaged as a graphic pack can also be installed using [[Help:Tools/BCML|BCML]], a mod loading tool. In addition to being simpler than manually extracting and enabling the mod, BCML is designed to resolve certain kinds of conflicts between different mods. Mods that modify the [[RSTB]], the same [[SARC]] files, or [[Message archives]] will not function properly together unless the changes are merged. BCML does this automatically. To install mods with BCML:

# Install BCML using the instructions [[Help:Tools/BCML#Setup|here]].
# '''Command line version''': Install a mod by running <code>bcml install path\to\mod.zip</code>. {{CLI help}} BCML will ask you to specify the directory where Cemu is installed first.
# '''Graphical version''': Open the GUI by running <code>bcml-gui</code>. {{CLI help}} Select the directory where Cemu is intalled. Then click "Install" and select the mod you want to install.

BCML should automatically enable installed mods in Cemu, but check to make sure by opening the Cemu graphic pack menu and looking in the "BCML Mods" category.

== Switch ==

=== Setting up homebrew ===
Follow [https://guide.sdsetup.com this guide] to set up your Switch console to use homebrew software.

This tutorial uses Atmosphère Custom Firmware (CFW). It is strongly recommended '''not''' to use other CFWs as they tend to be outdated, unsafe and/or use stolen code from Atmosphère.
{{warning|text=Running homebrew on your console may lead to it getting banned from Nintendo's online services (including eShop and game updates). Enabling Airplane Mode will not help, as telemetry reports are saved and sent to Nintendo the next time you connect to the internet.

However, this risk is very minimal as long as you are sensible and only use a safe, sane CFW (Atmosphère) and mods on offline games (don't install NSPs or pirate games!) as Atmosphère does not leave any trace on the system and disables some system telemetry.

If you are paranoid, turn on Airplane Mode ''before running homebrew for the first time'', then make a full system backup, and always stay offline until you restore that clean backup.}}

=== Disabling telemetry reports ===
The Switch version of ''Breath of the Wild'' sends many [[telemetry]] reports so when you are using mods that modify gameplay in a detectable way or add new content in any way, it is strongly recommended to disable telemetry reports because they are used by Zelda developers to understand how people play BotW and also to help them fix bugs.

Mods that modify actors are especially dangerous as they might cause the game to use the ActorSystem emergency heap and trigger many memory-related play reports.

To disable problematic telemetry reports:

* For 1.5.0, download this [http://static.zeldamods.org/patch_switch150_no_telemetry.ips patch], put it in <code>/atmosphere/exefs_patches/botw_no_telemetry/</code> (create new folders if required) and rename the file to <code>16A91992BBA71201E98756F3BC8F5D2F.ips</code>. This patch works for the Switch 1.5.0 [[executable]] only (build ID: 16A91992BBA71201E98756F3BC8F5D2F).

* For 1.6.0, download this [http://static.zeldamods.org/patch_switch160_no_telemetry.ips patch], put it at <code>/atmosphere/exefs_patches/botw_no_telemetry/</code> (create new folders if required) and rename the file to <code>8E9978D50BDD20B4C8395A106C27FFDE.ips</code>. This patch works for the Switch 1.6.0 [[executable]] only (build ID: 8E9978D50BDD20B4C8395A106C27FFDE).

=== Installing mods ===

# In the root of your MicroSD card, there should be a folder named <code>atmosphere</code>.
# Within that folder, there should be a folder named <code>contents</code>. Inside that, create a folder with the name of your game's Title ID. For BotW on Switch, the Title ID is <code>01007EF00011E000</code>. (In versions of Atmosphere prior to v0.10.0, the <code>contents</code> folder was instead called <code>titles</code>.)
# Inside that, make a folder called <code>romfs</code>. Your mod files will go in here. (Mods will often include all or part of this folder structure already, to make things easy.)

To use the mod, simply boot the console into CFW, then boot the game, and the mod will be active.

Note that mods are not permanently installed on the console. To remove all installed mods, simply delete <code>/atmosphere/contents/01007EF00011E000</code>.
[[Category:Guides]]

Help:Using mods

2020-12-08T22:29:49Z

NiceneNerd: Change instructions to WUPS SDCafiine

Welcome, players! This article will walk you through setting up BotW to play with mods. There are three different platforms you can play on:

* Wii U console
* Cemu, the Wii U emulator, on your computer
* Switch console

Almost all Wii U mods should work on both the console and Cemu, but most Switch mods aren't cross-compatible. In addition, many mods are only compatible with version 1.5.0 of BotW.

Note that any mods which edit any of the same files as each other will probably be incompatible and cause issues. Sometimes, mods that edit different files can also be unexpectedly incompatible. If you are using multiple mods and you find glitches, please figure out which mod / combination of mods is causing the issue before reporting it to the mod creator(s).

== Wii U Console ==

=== Setting up homebrew ===
Follow [https://wiiu.hacks.guide/ this guide] to set up your Wii U console to use homebrew software.

=== Setting up WUPS SDCafiine ===
SDCafiine is a Wii U homebrew program that will load modded game files from your SD card. The classic version has a history of serious stability problems, as the program eventually unloads from memory, and game files begin to revert to their unmodded state. An alternative version designed for the Wii U Plugin System (WUPS), so it is recommended.

# Download the latest nightly release of the Wii U Plugin Loader from [https://github.com/Maschell/WiiUPluginLoader/releases here].
# Extract the contents of the .zip into the root of your SD card.
# Download the latest WUPS nightly of SDCafiine from [https://github.com/Maschell/SDCafiine/releases/tag/SDCafiine-WUPS-v1.4-nightly-67aa461 here].
# Extract the contents of the .zip into the root of your SD card.
# Create a new folder in the root of your SD Card, named <code>sdcafiine</code>.
# Within that folder, create a new folder with the name of your game's Title ID. On Wii U, the JP version of BotW uses <code>00050000101C9300</code>, the US version uses <code>00050000101C9400</code>, and the EU version uses <code>00050000101C9500</code>.
# Within that folder, you can create any number of folders named after the mods you want to use. When you boot the game, a menu will appear allowing you to select one to use.
# Inside each of those folders, create a folder named <code>content</code>. Your mod files will go in here. (Mods will often include a <code>content</code> folder already to make things clear. If using BCML, this is where you will put the contents of the exported BCML pack.)

To use mods:
# Run the Wii U Plugin Loader option from the Homebrew Launcher
# Tick the SDCafiine plugin on and press '''+''' to Apply Patches.
# Back at the Wii U menu, launch BOTW.
# If you have only one mod, it will load automatically. If there are multiple mods, you will be prompted to select one to use.

== Cemu Emulator ==

=== Download Cemu Emulator ===
You can find the latest version of Cemu Emulator on the [http://cemu.info/ Official Cemu Website]

=== Setting up homebrew ===
Follow [https://wiiu.hacks.guide/ this guide] to set up your Wii U console to use homebrew software, in order to allow you to dump the game files from your console to your PC.

=== Dumping the game files ===
To play BotW on Cemu, you'll need to [[Help:Dumping games|dump the game files]] from the console to your computer. Then run the <code>U-King.rpx</code> file from Cemu to boot the game.

=== Installing the DLC ===
If you dumped the game's add-on content (aoc) files, follow [http://compat.cemu.info/wiki/Tutorial:How_to_install_a_DLC this guide] to install them in Cemu.

=== Setting up and Maximising Performance ===
Now that you have Cemu and your games files, it is recommended you use [http://compat.cemu.info/wiki/Serfrosts_Cemu_Setup_Guide Serfrosts Cemu Setup Guide] to maximise performance on your hardware before installing mods.

=== Installing mods with the graphic pack menu ===
Cemu uses "graphic packs" to install mods without overwriting any of the base files, allowing you to easily install or uninstall mods without leaving any trace.

Graphic packs are installed by placing the unzipped folder in <code>Cemu/graphicPacks/</code>. Note that most newer mods will come packaged as a graphic pack, or have a graphic pack option.

To check that the mod is a graphic pack, open the mod folder within <code>Cemu/graphicPacks/</code>. A graphic pack will have a file called <code>rules.txt</code> next to the <code>content</code> and/or <code>aoc</code> folder.

If a mod is not packaged as a graphic pack you will have to package it yourself, otherwise skip to the end of this section. This method works for versions of Cemu 1.15.1+

# Create a new folder inside <code>Cemu/graphicPacks/</code> named after the mod you want to use.
# Inside that folder, create a folder named <code>content</code>. Your mod files will go in here. (Mods will often include a <code>content</code> folder already to make things clear.)
# Create a file named <code>rules.txt</code> next to the <code>content</code> folder (if the downloaded mod doesn't already include one). Use this example as a template:

[Definition]
titleIds = 00050000101C9300,00050000101C9400,00050000101C9500
name = <Mod Name>
path = "The Legend of Zelda: Breath of the Wild/Mods/<Mod Name>"
description = <Mod description here>
version = 3
fsPriority = 100
<code>version</code> must be set to 3 to work correctly. <code>fsPriority</code> determines the order in which mods are prioritized - higher numbers prioritize that mod's files over other mods. Mods without an <code>fsPriority</code> entry specified will default to 100.

Once a mod has been added, simply enable it from Cemu's graphic pack menu to use it. You can find this menu in <code>Options > Graphic Packs</code> or by right-clicking a game and selecting <code>Edit Graphic Packs</code>.
Note that most mods should not be enabled or disabled while the game is running.

=== Installing mods using BCML ===
Mods that are already packaged as a graphic pack can also be installed using [[Help:Tools/BCML|BCML]], a mod loading tool. In addition to being simpler than manually extracting and enabling the mod, BCML is designed to resolve certain kinds of conflicts between different mods. Mods that modify the [[RSTB]], the same [[SARC]] files, or [[Message archives]] will not function properly together unless the changes are merged. BCML does this automatically. To install mods with BCML:

# Install BCML using the instructions [[Help:Tools/BCML#Setup|here]].
# '''Command line version''': Install a mod by running <code>bcml install path\to\mod.zip</code>. {{CLI help}} BCML will ask you to specify the directory where Cemu is installed first.
# '''Graphical version''': Open the GUI by running <code>bcml-gui</code>. {{CLI help}} Select the directory where Cemu is intalled. Then click "Install" and select the mod you want to install.

BCML should automatically enable installed mods in Cemu, but check to make sure by opening the Cemu graphic pack menu and looking in the "BCML Mods" category.

== Switch ==

=== Setting up homebrew ===
Follow [https://guide.sdsetup.com this guide] to set up your Switch console to use homebrew software.

This tutorial uses Atmosphère Custom Firmware (CFW). It is strongly recommended '''not''' to use other CFWs as they tend to be outdated, unsafe and/or use stolen code from Atmosphère.
{{warning|text=Running homebrew on your console may lead to it getting banned from Nintendo's online services (including eShop and game updates). Enabling Airplane Mode will not help, as telemetry reports are saved and sent to Nintendo the next time you connect to the internet.

However, this risk is very minimal as long as you are sensible and only use a safe, sane CFW (Atmosphère) and mods on offline games (don't install NSPs or pirate games!) as Atmosphère does not leave any trace on the system and disables some system telemetry.

If you are paranoid, turn on Airplane Mode ''before running homebrew for the first time'', then make a full system backup, and always stay offline until you restore that clean backup.}}

=== Disabling telemetry reports ===
The Switch version of ''Breath of the Wild'' sends many [[telemetry]] reports so when you are using mods that modify gameplay in a detectable way or add new content in any way, it is strongly recommended to disable telemetry reports because they are used by Zelda developers to understand how people play BotW and also to help them fix bugs.

Mods that modify actors are especially dangerous as they might cause the game to use the ActorSystem emergency heap and trigger many memory-related play reports.

To disable problematic telemetry reports:

* For 1.5.0, download this [http://static.zeldamods.org/patch_switch150_no_telemetry.ips patch], put it in <code>/atmosphere/exefs_patches/botw_no_telemetry/</code> (create new folders if required) and rename the file to <code>16A91992BBA71201E98756F3BC8F5D2F.ips</code>. This patch works for the Switch 1.5.0 [[executable]] only (build ID: 16A91992BBA71201E98756F3BC8F5D2F).

* For 1.6.0, download this [http://static.zeldamods.org/patch_switch160_no_telemetry.ips patch], put it at <code>/atmosphere/exefs_patches/botw_no_telemetry/</code> (create new folders if required) and rename the file to <code>8E9978D50BDD20B4C8395A106C27FFDE.ips</code>. This patch works for the Switch 1.6.0 [[executable]] only (build ID: 8E9978D50BDD20B4C8395A106C27FFDE).

=== Installing mods ===

# In the root of your MicroSD card, there should be a folder named <code>atmosphere</code>.
# Within that folder, there should be a folder named <code>contents</code>. Inside that, create a folder with the name of your game's Title ID. For BotW on Switch, the Title ID is <code>01007EF00011E000</code>. (In versions of Atmosphere prior to v0.10.0, the <code>contents</code> folder was instead called <code>titles</code>.)
# Inside that, make a folder called <code>romfs</code>. Your mod files will go in here. (Mods will often include all or part of this folder structure already, to make things easy.)

To use the mod, simply boot the console into CFW, then boot the game, and the mod will be active.

Note that mods are not permanently installed on the console. To remove all installed mods, simply delete <code>/atmosphere/contents/01007EF00011E000</code>.
[[Category:Guides]]

Help:Creating mods

2020-12-08T21:58:49Z

NiceneNerd: Update state of modding

Welcome, modders! This page contains useful information for anybody who wants to create mods. If you just want to use other people's mods, see [[Help:Using mods]].

== What can currently be modded? ==

* Textures
* Models
* Actor parameters, including enemies, weapons, and armors
* Adding new actors
* Overworld and dungeon map files
* Event flows, and as a direct consequence: cutscenes, NPC interactions, quests, minigames, etc.
* Rigid body collisions
* Text / dialogue
* UI elements (HUD, title screen, logos, etc.)
* Music and audio (cannot add new tracks, only edit/replace existing)
* Effects and shaders (limited)

== Getting set up ==
 
{{linkbox
| title = [[help:Dumping games|Dumping the game files]]
| text = To make mods, you'll need to start by dumping the unedited game files from your copy of BotW.
| faiconc = fas fa-copy
}}
{{linkbox
| title = [[help:Setting up tools|Setting up tools]]
| text = Since BotW uses a lot of Nintendo's own file formats, you'll need tools to be able to edit them.
| faiconc = fas fa-toolbox
}}

== Rules ==

=== The RSTB file ===
The file [[ResourceSizeTable.product.rsizetable]] (referred to as the RSTB file) contains a list of size limits for almost every file in the game (calculated from the non-Yaz0-compressed file sizes). If you edit a file to make its filesize bigger, you'll need to edit this file to prevent errors. For details, see [[Help:Updating the RSTB]].

=== File names and caching ===
The game assumes that any 2 files with the exact same filename also have the exact same contents. If you don't follow this rule when editing files, the game might load the wrong version of the file, leading to errors. The same rule applies to texture names - all unique textures should have unique names, even if they're located in different files.

=== File extensions for compressed resources ===
In most cases, file extensions that start with ".s" are used for [[Yaz0]]-compressed files. Ensure that any file with such extensions is compressed. Some tools (for example {{ltool|BotW Unpacker}}, {{ltool|byml-v2}} or {{ltool|sarc}}) will automatically compress files when needed.

Example: .bactorpack -> .sbactorpack (after compression)

=== Edit priority ===
If a file exists in your update dump, edit that copy of it. If it doesn't exist there, edit the one in your DLC dump. If it doesn't exist in either the update files or the DLC files, edit the one from the base game dump.

Help:Setting up tools

2020-09-18T19:05:54Z

NiceneNerd: Correct Python installer link

''Breath of the Wild'' uses a very flexible game engine, so many aspects of the game can be configured with files. Since BotW uses a lot of custom formats, special tools are required for editing them.

== Common requirements ==
=== Python ===
Many of the tools for these formats require [[wikipedia:Python (programming language)|Python]] 3.7+ ('''64 bit version''') to be installed.

On Linux, Python 3 is surely already installed. Just make sure you have a recent enough version (3.7+). Ubuntu 16.04 and Debian stretch are too old; the latest Ubuntu LTS (18.04) and rolling distros such as Arch and Debian sid have 3.7+ in their repos.

{{alert|class=primary|text= Setup instructions

On Windows, follow the below instructions to install Python:
# Uninstall any existing Python version to avoid conflicts.
# Download the [https://www.python.org/ftp/python/3.7.7/python-3.7.7-amd64.exe Python 3.7 installer] (latest version as of July 2019).
# Run the installer: do a ''system-wide install'' and tick the "''add Python to environment variables / PATH''" option. Note that if you install to the Program Files folder, you may occasionally run into permission issues with certain Python programs. To avoid this, install Python somewhere that does not require administrator permissions, such as <code>C:\Python37</code>.
# Verify that <code>py -3 --version</code> works and gives the correct version (3.7 or higher). {{CLI help}}

If you have any trouble installing Python, or need more detailed instructions, you can use [https://www.youtube.com/watch?v=ndrCfBJkkvE this video tutorial].
}}

=== For Windows users: Visual C++ redistributable for Visual Studio 2019 ===
Several tools require the [https://aka.ms/vs/16/release/vc_redist.x64.exe 64-bit Visual C++ redistributable for Visual Studio 2019] to be installed. To be clear, Visual Studio is '''not''' required.

Failure to install the redistributable will cause several Python tools to fail with the error "ImportError: DLL load failed".

== Tools ==
=== Yaz0 ===
Many files in the game are compressed with the [[Yaz0]] format. Compressed files generally have the letter <code>s</code> prefixed to their file extension. Use {{ltool|wszst}} to compress or decompress these files.

=== AAMP ===
[[AAMP]] is used for configuration files, such as [[actor parameters]], the [[normal.bwinfo|world configuration (climate, lighting, ...)]], etc. Convert them to an editable format (and back) with {{ltool|aamp}}. {{ltool|Wild Bits}} can also edit AAMP files.

Note: Unlike most other files, AAMP files are exactly the same on both Wii U and Switch.

=== BYML ===
[[BYML]] files contain game parameters for [[actor]]s, [[map unit]]s, etc. Convert them to an editable format (and back) with {{ltool|byml-v2}}. {{ltool|Wild Bits}} can also edit BYML files.

=== BFRES ===
[[BFRES]] files contain the game's animations, models and textures. The format is different on and on Switch and Wii U. These can be edited on Switch and Wii U using [https://github.com/KillzXGaming/Switch-Toolbox Switch Toolbox] (this tool is still under active development and receives very frequent updates, so expect some bugs in some features). Tutorials on another, older method of editing these for (Wii U only) can be found in [https://drive.google.com/drive/folders/1Z1_A3w0VvPHp22H_Yh_dSdzI5hr4OAv9 Fooni's Tutorials].
* <code>.sbfres</code> files contain models.
* <code>.Tex1.sbfres</code> files contain textures (Wii U).
* <code>.Tex2.sbfres</code> files contain mipmaps for textures (Wii U). They can be edited with Switch Toolbox (when editing a Tex1 manually, it automatically edits any Tex2 in the same folder with the same filename). Alternatively, they can be disabled with [https://github.com/CEObrainz/Botw-AutoMipping Auto MipMap removal] (has the side effect of making the textures take a moment to load correctly).
* <code>.Tex.sbfres</code> files contain both textures and mipmaps (Switch). Unlike on Wii U, mipmaps don't cause any problems here.

=== BFEVFL ===
[[BFEVFL]] is used for in-game events (which includes things like talking to people and also full-blown cutscenes).

Use {{ltool|EventEditor}} to edit event flowcharts.

=== RSTB ===
[[ResourceSizeTable.product.rsizetable]] (known as the RSTB) contains sizes for almost every file in the game (calculated from the non-Yaz0-compressed file sizes). If you edit a file to make its filesize bigger, you'll need to edit this file to prevent errors. The recommended tool for manipulating the RSTB is {{ltool|rstb}}. {{ltool|Wild Bits}} also provides a GUI frontend for <code>rstb</code>.

=== SARC ===
[[SARC]] archives contain collections of other files and folders, like .zip folders.

Use {{ltool|sarc}} to create or modify archives. {{ltool|Wild Bits}} also provides a GUI frontend for <code>sarc</code>.

=== Map units ===
[[Map unit]]s can be edited directly by modifying the map unit [[BYML]]s or with a graphical tool such as Ice-Spear.

For the first method, refer to [[#BYML]].

For the second method, follow [https://gitlab.com/ice-spear-tools/ice-spear-builds the instructions in the official repo for Ice-Spear builds].

=== MSBT ===
[[MSBT]] files contain game texts. Convert them to an editable YAML format (and back) with {{ltool|msyt}} or (built on top of msyt) [https://github.com/polarbunny/msyt-tools msyt-tools]. Wild Bits also provides a GUI frontend for msbt.

== Reverse engineering ==
To reverse engineer the game [[executable]], it is strongly recommended to have a copy of IDA Pro 7.0+ because the main executable is fairly large and IDA is as of September 2018 the only serious option for analysing such binaries. It is also the only tool with a usable decompiler for AArch64 (Switch).

To get a copy of an IDC for Switch 1.5.0, ping [[User:leoetlino|leoetlino]].

[[Category:Guides]]

Help:Editing Actor Parameters

2020-07-13T14:59:14Z

NiceneNerd:

[[Category:Guides]]
Making changes to an [[Actor|actor's]] [[ActorParam|parameters]] is one of the most basic and common types of editing in BOTW modding. This brief guide will introduce the process in its simplest form.

== Prerequisites ==
* Python 3.7+ 64 bit (more details at [[Help:Setting up tools]])
* [[Help:Tools/Wild_Bits|Wild Bits]]

== Mod Preparation ==

=== Folder Setup ===
First you will need to create a folder structure for your mod. For Wii U/Cemu, the format is pretty well standardized. To make a simple parameter edit for an actor, create a setup like this:
<pre>
MyMod
└── content
└── Actor
└── Pack
</pre>

For Switch, format conventions vary. This guide will use the format expected by [[Help:Tools/BCML|BCML]] and [[Help:Tools/Hyrule_Builder|Hyrule Builder]]:
<pre>
MyMod
└── 01007EF00011E000
└── romfs
└── Actor
└── Pack
</pre>

=== File Setup ===
Next, you will need to copy the [[Actor pack|actor pack(s)]] for the actor(s) you want to edit from your [[Help:Dumping games|game dump]] into your project. Be sure to use the latest update files—version 1.5.0 for Wii U or 1.6.0 for Switch—to ensure general compatibility. If you don't know the name of the actor you want to edit, use [https://github.com/MrCheeze/botw-tools/blob/master/botw_names.json this actor ID reference] to look it up. For example, if you wanted to edit the torch, <code>Weapon_Sword_023</code>, you would copy <code>Actor/Pack/Weapon_Sword_023.sbactorpack</code> into you mod's <code>Actor/Pack</code> content folder.

Actor parameters which appear somewhere in the game's UI (e.g. the armor rating in the inventory, the price in a shop) will generally have a corresponding value in the actor's entry in [[ActorInfo.product.sbyml]]. If you are editing one of these values, you will also need to copy this actor info file from your update files into your mod as <code>Actor/ActorInfo.product.sbyml</code>.

== Editing Parameters ==
Now that the mod's basic structure is set up with the original files, you can proceed to making edits. Open Wild Bits to the SARC tab, and then open the actor pack you want to edit.

The SARC view will present you with a tree of the files and folders inside the actor pack. To edit parameters, expand the tree to the file you would like to edit. Often this will be in the [[bgparamlist|general parameter list]], e.g. <code>Actor/GeneralParams/Weapon_Sword_024.bgparamlist</code>. Select the file and then click Edit, which will open the file in YAML tab.

In the YAML tab, all of the parameters will be easily viewable and editable. For information on what the individual parameters are or mean, check [[Category:Actor parameter files]]. Once you have made your edits, click Save in the YAML tab. Once you have saved all of the files you want to edit, click Save in the SARC tab as well.

If any of the edits you have made involve values which would appear in the UI, next open <code>Actor/ActorInfo.product.sbyml</code> in the Wild Bits YAML tab, find the actor you edited, and update the relevant parameters to match the changes you made in the actor pack.

== Using the Mod ==
At this point, you've completed the actual modding part of the process. The next step would be simply packaging your mod files into the format you wish to use, whether BNP or graphic pack or Atmosphere mod. Usually, for Cemu you will want to add a <code>rules.txt</code> file or use the BNP maker in BCML. For Wii U, you don't need to add anything; just place the results in the correct SDCafiine folder. For Switch, you will want to copy the output into your Atmosphere titles or contents folder. For more on this process, see [[Help:Using mods]].

Help:Editing Actor Parameters

2020-07-10T03:01:13Z

NiceneNerd: /* Prerequisites */

Making changes to an [[Actor|actor's]] [[ActorParam|parameters]] is one of the most basic and common types of editing in BOTW modding. This brief guide will introduce the process in its simplest form.

== Prerequisites ==
* Python 3.7+ 64 bit (more details at [[Help:Setting up tools]])
* [[Help:Tools/Wild_Bits|Wild Bits]]

== Mod Preparation ==

=== Folder Setup ===
First you will need to create a folder structure for your mod. For Wii U/Cemu, the format is pretty well standardized. To make a simple parameter edit for an actor, create a setup like this:
<pre>
MyMod
└── content
└── Actor
└── Pack
</pre>

For Switch, format conventions vary. This guide will use the format expected by [[Help:Tools/BCML|BCML]] and [[Help:Tools/Hyrule_Builder|Hyrule Builder]]:
<pre>
MyMod
└── 01007EF00011E000
└── romfs
└── Actor
└── Pack
</pre>

=== File Setup ===
Next, you will need to copy the [[Actor pack|actor pack(s)]] for the actor(s) you want to edit from your [[Help:Dumping games|game dump]] into your project. Be sure to use the latest update files—version 1.5.0 for Wii U or 1.6.0 for Switch—to ensure general compatibility. If you don't know the name of the actor you want to edit, use [https://github.com/MrCheeze/botw-tools/blob/master/botw_names.json this actor ID reference] to look it up. For example, if you wanted to edit the torch, <code>Weapon_Sword_023</code>, you would copy <code>Actor/Pack/Weapon_Sword_023.sbactorpack</code> into you mod's <code>Actor/Pack</code> content folder.

Actor parameters which appear somewhere in the game's UI (e.g. the armor rating in the inventory, the price in a shop) will generally have a corresponding value in the actor's entry in [[ActorInfo.product.sbyml]]. If you are editing one of these values, you will also need to copy this actor info file from your update files into your mod as <code>Actor/ActorInfo.product.sbyml</code>.

== Editing Parameters ==
Now that the mod's basic structure is set up with the original files, you can proceed to making edits. Open Wild Bits to the SARC tab, and then open the actor pack you want to edit.

The SARC view will present you with a tree of the files and folders inside the actor pack. To edit parameters, expand the tree to the file you would like to edit. Often this will be in the [[bgparamlist|general parameter list]], e.g. <code>Actor/GeneralParams/Weapon_Sword_024.bgparamlist</code>. Select the file and then click Edit, which will open the file in YAML tab.

In the YAML tab, all of the parameters will be easily viewable and editable. For information on what the individual parameters are or mean, check [[Category:Actor parameter files]]. Once you have made your edits, click Save in the YAML tab. Once you have saved all of the files you want to edit, click Save in the SARC tab as well.

If any of the edits you have made involve values which would appear in the UI, next open <code>Actor/ActorInfo.product.sbyml</code> in the Wild Bits YAML tab, find the actor you edited, and update the relevant parameters to match the changes you made in the actor pack.

== Using the Mod ==
At this point, you've completed the actual modding part of the process. The next step would be simply packaging your mod files into the format you wish to use, whether BNP or graphic pack or Atmosphere mod. Usually, for Cemu you will want to add a <code>rules.txt</code> file or use the BNP maker in BCML. For Wii U, you don't need to add anything; just place the results in the correct SDCafiine folder. For Switch, you will want to copy the output into your Atmosphere titles or contents folder. For more on this process, see [[Help:Using mods]].

Help:Editing Actor Parameters

2020-07-10T02:48:52Z

NiceneNerd: Initial post

Making changes to an [[Actor|actor's]] [[ActorParam|parameters]] is one of the most basic and common types of editing in BOTW modding. This brief guide will introduce the process in its simplest form.

== Prerequisites ==
* Python 3.6+ 64 bit (more details at [[Help:Setting up tools]])
* [[Help:Tools/Wild_Bits|Wild Bits]]

== Mod Preparation ==

=== Folder Setup ===
First you will need to create a folder structure for your mod. For Wii U/Cemu, the format is pretty well standardized. To make a simple parameter edit for an actor, create a setup like this:
<pre>
MyMod
└── content
└── Actor
└── Pack
</pre>

For Switch, format conventions vary. This guide will use the format expected by [[Help:Tools/BCML|BCML]] and [[Help:Tools/Hyrule_Builder|Hyrule Builder]]:
<pre>
MyMod
└── 01007EF00011E000
└── romfs
└── Actor
└── Pack
</pre>

=== File Setup ===
Next, you will need to copy the [[Actor pack|actor pack(s)]] for the actor(s) you want to edit from your [[Help:Dumping games|game dump]] into your project. Be sure to use the latest update files—version 1.5.0 for Wii U or 1.6.0 for Switch—to ensure general compatibility. If you don't know the name of the actor you want to edit, use [https://github.com/MrCheeze/botw-tools/blob/master/botw_names.json this actor ID reference] to look it up. For example, if you wanted to edit the torch, <code>Weapon_Sword_023</code>, you would copy <code>Actor/Pack/Weapon_Sword_023.sbactorpack</code> into you mod's <code>Actor/Pack</code> content folder.

Actor parameters which appear somewhere in the game's UI (e.g. the armor rating in the inventory, the price in a shop) will generally have a corresponding value in the actor's entry in [[ActorInfo.product.sbyml]]. If you are editing one of these values, you will also need to copy this actor info file from your update files into your mod as <code>Actor/ActorInfo.product.sbyml</code>.

== Editing Parameters ==
Now that the mod's basic structure is set up with the original files, you can proceed to making edits. Open Wild Bits to the SARC tab, and then open the actor pack you want to edit.

The SARC view will present you with a tree of the files and folders inside the actor pack. To edit parameters, expand the tree to the file you would like to edit. Often this will be in the [[bgparamlist|general parameter list]], e.g. <code>Actor/GeneralParams/Weapon_Sword_024.bgparamlist</code>. Select the file and then click Edit, which will open the file in YAML tab.

In the YAML tab, all of the parameters will be easily viewable and editable. For information on what the individual parameters are or mean, check [[Category:Actor parameter files]]. Once you have made your edits, click Save in the YAML tab. Once you have saved all of the files you want to edit, click Save in the SARC tab as well.

If any of the edits you have made involve values which would appear in the UI, next open <code>Actor/ActorInfo.product.sbyml</code> in the Wild Bits YAML tab, find the actor you edited, and update the relevant parameters to match the changes you made in the actor pack.

== Using the Mod ==
At this point, you've completed the actual modding part of the process. The next step would be simply packaging your mod files into the format you wish to use, whether BNP or graphic pack or Atmosphere mod. Usually, for Cemu you will want to add a <code>rules.txt</code> file or use the BNP maker in BCML. For Wii U, you don't need to add anything; just place the results in the correct SDCafiine folder. For Switch, you will want to copy the output into your Atmosphere titles or contents folder. For more on this process, see [[Help:Using mods]].

Help:Tools/Wild Bits

2020-07-10T01:41:43Z

NiceneNerd: /* Usage */

[[Category:Tools]]
[[Category:Tools (SARC)]]
[[Category:Tools (AAMP)]]
[[Category:Tools (BYML)]]
[[Category:Tools (RSTB)]]
[[Category:Tools (MSBT)]]
{{Tool infobox
| name = Wild Bits
| authors = NiceneNerd
| source = https://github.com/NiceneNerd/Wild-Bits/
| license = GPLv3+
| written_in = Python
| win_only=
}}

Wild Bits is a graphical frontend for several tools in the <code>oead</code> Python library and the [[Help:Tools/msyt|MSYT]] editor for MSBTs.

== Setup ==
# Ensure you have a '''64 bit version''' of Python 3.'''7+''' before continuing. Windows users must also install the latest x64 Visual C++ redistributable. You will not be able to install or launch Wild Bits otherwise. See [[Help:Setting_up_tools]].
# (Optional) For best results on Windows, install <code>cefpython3</code>. {{Install py package help|package=cefpython3}}
# Install the <code>wildbits</code> package. {{Install py package help|package=wildbits}}

== Usage ==
[[File:Wild Bits UI preview.png|250px|thumb|right]]
Wild Bits can be launched with the <code>wildbits</code> command.{{CLI help}} A desktop shortcut can also be made pointing to the executable in Python's <code>Scripts</code> directory.

The main Wild Bits interface has 3 tabs corresponding to its main functions: a SARC editor, an RSTB editor, and a YAML editor. Each editor supports both Wii U and Switch (big and little endian) formats where relevant and will automatically keep track of them. Each editor also automatically handles yaz0 decompression when loading, and will recompress on saving if the file extension begins with <code>.s</code>.

For more details on using Wild Bits, see the [https://github.com/NiceneNerd/Wild-Bits/blob/master/docs/README.md readme on GitHub].

== Known issues ==
On some system configurations, launching with <code>wildbits</code> doesn't work and you must use <code>python -m wildbits</code> instead.

File:Wild Bits UI preview.png

2020-07-10T01:40:48Z

NiceneNerd: NiceneNerd moved page File:68747470733a2f2f692e696d6775722e636f6d2f695247394859662e706e67.png to File:Wild Bits UI preview.png without leaving a redirect

File:Wild Bits UI preview.png

2020-07-10T01:40:13Z

NiceneNerd:

Help:Tools/Wild Bits

2020-07-10T01:39:08Z

NiceneNerd: Significant update

[[Category:Tools]]
[[Category:Tools (SARC)]]
[[Category:Tools (AAMP)]]
[[Category:Tools (BYML)]]
[[Category:Tools (RSTB)]]
[[Category:Tools (MSBT)]]
{{Tool infobox
| name = Wild Bits
| authors = NiceneNerd
| source = https://github.com/NiceneNerd/Wild-Bits/
| license = GPLv3+
| written_in = Python
| win_only=
}}

Wild Bits is a graphical frontend for several tools in the <code>oead</code> Python library and the [[Help:Tools/msyt|MSYT]] editor for MSBTs.

== Setup ==
# Ensure you have a '''64 bit version''' of Python 3.'''7+''' before continuing. Windows users must also install the latest x64 Visual C++ redistributable. You will not be able to install or launch Wild Bits otherwise. See [[Help:Setting_up_tools]].
# (Optional) For best results on Windows, install <code>cefpython3</code>. {{Install py package help|package=cefpython3}}
# Install the <code>wildbits</code> package. {{Install py package help|package=wildbits}}

== Usage ==
Wild Bits can be launched with the <code>wildbits</code> command.{{CLI help}} A desktop shortcut can also be made pointing to the executable in Python's <code>Scripts</code> directory.

The main Wild Bits interface has 3 tabs corresponding to its main functions: a SARC editor, an RSTB editor, and a YAML editor. Each editor supports both Wii U and Switch (big and little endian) formats where relevant and will automatically keep track of them. Each editor also automatically handles yaz0 decompression when loading, and will recompress on saving if the file extension begins with <code>.s</code>.

For more details on using Wild Bits, see the [https://github.com/NiceneNerd/Wild-Bits/blob/master/docs/README.md readme on GitHub].

== Known issues ==
On some system configurations, launching with <code>wildbits</code> doesn't work and you must use <code>python -m wildbits</code> instead.