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

Difficulty scaling

2025-04-27T17:23:08Z

Savage13: /* Enemies */ Add reference to enemies in Test of Strength shrines in Master Mode not being ranked up.

<languages/>
<translate>


'''Difficulty scaling''' is a mechanic in ''Breath of the Wild'' that results in enemies and weapons being progressively replaced by more powerful variants during a playthrough.

== Points == 


The scaling system is based on a point system. Killing enemies is the ''only way'' to receive points.


Whenever an enemy dies, the game increments a flag 'Defeated_{SameGroupActorName}_Num' if all of the following conditions are satisfied:
* The current kill count is < 10.
* The actor does not have the NotCountDefeatedNum [[actor tag]].
* '''For Monk Maz Koshia''': 'Defeated_Priest_Boss_Normal_Num' is 0.
* '''For Dark Beast Ganon''': It is the first time the boss is beaten. (Ganon's Defeated flag has 1 as the maximum value.)
* '''For Blights''': It is the first time the blight is beaten in the Divine Beast, or in the Illusory Realm. Blights fought in Hyrule Castle do not count.
This happens every time ''any'' enemy dies, even if they don't necessarily play a role in the point system (see below) and even if the player is not responsible for their death.


Because enemies have to be killed throughout the main quest and bosses are considered as enemies too, difficulty scaling is unavoidable.


Only the defeated counter flags are stored in the save file. The <code>Ecosystem::LevelSensor</code> subsystem is responsible for [[Difficulty scaling#Ecosystem::LevelSensor::calculatePoints|converting these kill counts to points]] using a [[Difficulty scaling#Ecosystem::LevelSensor::loadByml|configuration file]].


The subsystem provides two functions ([[Difficulty scaling#Ecosystem::LevelSensor::scaleWeapon|<code>scaleWeapon</code>]] and [[Difficulty scaling#Ecosystem::LevelSensor::scaleActor|<code>scaleActor</code>]]) that may be called when a weapon or enemy actor is created.

== Scaling inhibitors == 


Both scaling functions will immediately return without doing anything if:
* [[WorldMgr]]::sInstance->stageType == 1 (Open World [[stage]])
* and WorldMgr::sInstance->isAocField (current map is Trial of the Sword)
* and WorldMgr::sInstance->disableScaling (set to true when entering Trial of the Sword)


This means that scaling is always disabled in the Trial of the Sword.


Scaling will also be skipped if the current [[map area]] is 28. This corresponds to "HateruSea", which is the Eventide Island area.

== Weapons == 


'scaleWeapon' is called (i.e. weapons may be scaled) for a weapon if:
* '''For standalone weapons''': The actor property 'LevelSensorMode' is higher than 1 '''and''' it wasn't already picked up.
* '''For treasure chest drops''': If SharpWeaponJudgeType is not 4, when [[AIDef:AI/TreasureBox]] initialises the drop actor.
* '''For Hinox weapons''': The flag <code>{MapName}_Necklace_{i}_{HinoxName}_{ID}</code> is false.
* '''For other enemy drops''': The flag <code>{MapName}_WeaponDrop_{ID}</code> is false, '''and''' [the actor property 'LevelSensorMode' is higher than 1 ''or'' the enemy is a Guardian Scout ('Enemy_Guardian_Mini')].


Note: Weapons that are bought from a shop cannot receive modifiers because they do not fit into any of the above cases.

== Weapon modifiers == 


Weapon scaling results in weapons being replaced by a different weapon (e.g. a Soldier's Bow which becomes a Royal Bow), or weapons gaining a random, bonus stat boost (e.g. Attack Up, Durability Up, etc.). The range of those boosts is also affected by weapon scaling.


There are two bonus tiers in the game: one for low-level types (which appear in blue/white in the game UI) and another for high-level types (yellow). Those that belong to the Yellow tier are usually superior to the other ones. For instance, ''Attack Up +'' is the superior variant of ''Attack Up'' and it typically grants a higher attack power boost compared to ''Attack Up''.

=== Modifier types === 


Which modifier a weapon receives is random each time Link obtains it. Which modifiers a weapon can possibly have is specific for each in [[ActorParam/GeneralParamList]], and is based on the weapon's type and the modifier tier. Note that certain modifiers can only appear at certain tiers— in particular, this means once a weapon is scaled to yellow modifiers, it can no longer receive the Critical Hit buff.

The odds for each type of modifier is determined by an algorithm in actWeapon which depends on the possible modifiers for a given weapon at a given tier. As such, this algorithm yields the following odds for different types of weapons:
</translate>
{|class="wikitable" style="text-align: center;"
! rowspan=2|Weapon !! rowspan=2|Modifier Tier !! AddAtk !! AddLife !! AddCrit !! AddGuard !! AddThrow !! AddSpreadFire !! AddZoomRapid !! AddRapidFire !! AddSurfMaster
|-
| <translate> Attack Up</translate> || <translate> Durability Up</translate> || <translate> Critical Hit</translate> || <translate> Shield Guard Up</translate> || <translate> Long Throw</translate> || <translate> 5-Shot Burst</translate> || <translate> ''Unused''[[#Notes|[a] ]]</translate> || <translate> Quick Shot</translate> || ''Unused''[[#Notes|[b] ]]
|-
| Most melee weapons || White/Blue || 25% || 33.3̅3̅% || 41.6̅6̅% || - || - || - || - || - || -
|-
| Most melee weapons || Yellow || 25% || 33.3̅3̅% || - || - || 41.6̅6̅% || - || - || - || -
|-
| Traveler's Sword/ Rusty Broadsword || White/Blue || 50% || 50% || Impossible || - || - || - || - || - || -
|-
| Boomerangs, elemental rods and wind items || Yellow || 50% || 50% || - || - || Impossible || - || - || - || -
|-
| Shields || White/Blue || - || 50% || - || 50%[[#Notes|[c] ]] || - || - || - || - || -
|-
| Shields || Yellow || - || 50% || - || 50%[[#Notes|[c] ]] || - || - || - || - || -
|-
| Bows || White/Blue || 50% || 50% || - || - || - || - || - || - || -
|-
| Normal Bows || Yellow || 25% || 33.3̅3̅% || - || - || - || - || - || 41.6̅6̅% || -
|-
| Multi-Shot Bows[[#Notes|[d] ]] || Yellow || 12.5% || 22.2̅2̅% || - || - || - || 29.16̅% || - || 36.1̅1̅% || -
|-
|}

<translate>
==== Notes ==== 
* [a] AddSurfMaster, or "Shield Surf Up" is a bonus that only applies to shields and gives them a lower friction for shield surfing. That bonus type is unused in the game, though if implemented through mods or glitches it uses a yellow shield icon and reads "Shield Surf Up"
* [b] AddZoomRapid is another unused bonus that gives bows a zoom when aimed, similar to the property inherent to the Golden and Phrenic Bows.
* [c] Due to a bug, if "Shield Guard Up" is rolled for an amiibo weapon, "Durability Up" will be applied using that value instead.<ref name="amiiboShield">The bugged code is in function {{addr|a=0x71002df7d8|ver=nx-1.5.0}}.</ref>
* [d] These are for bows which can have the Five-Shot Burst modifier, which are the Forest Dweller's Bow, Lynel Bow, Mighty Lynel Bow, and the Savage Lynel Bow. (Despite shooting multiple arrows, the Duplex Bow and Great Eagle Bow cannot have this modifier.)

====Impossible modifiers====
Some items of a weapon type are furthermore restricted from certain modifiers, or the only ones that can receive it:
*Cannot receive Critical Hit (<code>SharpWeaponAddCrit</code> is false):
** Odd cases: Traveler's Sword, Rusty Broadsword
** Special weapons: Master Sword, One-Hit Obliterator
*Cannot receive Long Throw (<code>PoweredSharpAddThrowMin || PoweredSharpAddThrowMax == 1.0</code>):
** Boomerangs: Boomerang, Giant Boomerang, Lizal Boomerang, Lizal Forked Boomerang, Lizal Tri-Boomerang, Lizalfos Arm, Sea-Breeze Boomerang
** Elemental rods: Fire Rod, Ice Rod, Lightning Rod, Meteor Rod, Blizzard Rod, Thunderstorm Rod
** Wind-blowing weapons: Korok Leaf, Windcleaver
** Special weapons: Master Sword, One-Hit Obliterator
*Can receive Five-Shot Burst (<code>PoweredSharpAddSpreadFire</code> is true):
** Forest Dweller's Bow, Lynel Bow, Mighty Lynel Bow, Savage Lynel Bow
*The Hero's Shield will never recieve Shield Guard up due to only being obtainable from amiibo.

There are also some items that have values for modifiers in their parameters, but in all actual in-game cases have scaling restricted. This is mostly weapons only obtainable through crafting or shops.
*Never seen with any modifiers:
**Only from purchasing: Ancient Short Sword, Ancient Bladesaw, Ancient Shield, Ancient Bow, Spring-Loaded Hammer
**Champions' weapons restricted: Scimitar of the Seven, Daybreaker, Boulder Breaker, Great Eagle Bow, Ceremonial Trident, Lightscale Trident
**Skeleton arms: Bokoblin Arm, Lizalfos Arm, Moblin Arm
**Random items: Farmer's Pitchfork
**Special weapon: Bow of Light
*Never seen with yellow modifiers (only white):
**Random items: Tree Branch, Soup Ladle, Boat Oar, Woodcutter's Axe, Wooden Mop, Pot Lid, Wooden Bow

Finally, there are some items which either have limited instances where scaling is allowed and/or limited modifier availability before they upgrade. A list can be found [https://docs.google.com/spreadsheets/d/1RdV6RsHucg4h22sIZOEBsGSE7Mxk4zUipsADoGIjkOk/pubhtml# here].

=== Modifier values === 


Bonus values (e.g. the actual durability or attack power increase) are determined from [[ActorParam/GeneralParamList]] (with a copy of the information in [[ActorInfoData]]). Valid ranges and bonuses for each weapon are configured in the WeaponCommon section. The possible values for a bonus are generally higher for a yellow tier.

==== Non-amiibo weapons ==== 
</translate>
{|class="wikitable" style="text-align: center;"
! <translate> Modifier chosen</translate> !! Effect if applied !! Bonus Value (White/Blue) !! Bonus Value (Yellow)
|-
| <translate> None</translate> || - || - || -
|-
| <translate> Attack Up</translate> || Attack value boosted by: || Random integer between [SharpWeaponAddAtkMin, SharpWeaponAddAtkMax] || Random integer between [PoweredSharpAddAtkMin, PoweredSharpAddAtkMax]
|-
| <translate> Durability Up</translate> || Durability value boosted by: || Random integer between [SharpWeaponAddLifeMin, SharpWeaponAddLifeMax] || Random integer between [PoweredSharpAddLifeMin, PoweredSharpAddLifeMax]
|-
| Critical Hit || Last hit of a chain does double damage/staggers enemies || - || N/A
|-
| <translate> Shield Guard Up</translate> || Shield guard value boosted by: || Random integer between [SharpWeaponAddGuardMin, SharpWeaponAddGuardMax] || Random integer between [PoweredSharpWeaponAddGuardMin, PoweredSharpWeaponAddGuardMax]
|-
| <translate> Long Throw</translate> || Throw distance multiplied by: || - || Random float between [PoweredSharpAddThrowMin, PoweredSharpAddThrowMax]
|-
| <translate> Multi-Shot Burst</translate> || Bow shoots multiple arrows: || - || 5
|-
| ''AddZoomRapid'' || Reticle zooms when aiming || - || Unknown {{check}}
|-
| <translate> Quick Shot</translate> || Firing rate multiplied by: || - || Random float between [PoweredSharpAddRapidFireMin, PoweredSharpAddRapidFireMax]
|-
| <translate> ''AddSurfMaster''</translate> || Shield surfing friction multiplied by: || - || 0.2 (from [[GlobalParameter]]::ShieldSurfMasterFrictionRatio)
|}

<translate>

In summary, for non-amiibo weapons, a modifier bonus results in a randomized additional value in a certain range for each item.

==== amiibo weapons ==== 


Because of a bug in the game code<ref name="amiiboShield"></ref>, any time the game randomly chooses the "Shield Guard Up" bonus, the actual bonus that gets assigned to the weapon and shows up in the user interface is "Durability Up". For this reason, the extra durability value that is used for shields with the "Durability Up" bonus is either addLifeMax or addGuardMax, depending on which bonus was chosen.
</translate>

{|class="wikitable" style="text-align: center;"
! <translate> Modifier chosen</translate> !! Effect if applied !! Bonus Value (White/Blue) !! Bonus Value (Yellow)
|-
| <translate> None</translate> || - || - || -
|-
| <translate> Attack Up</translate> || Attack value boosted by: || SharpWeaponAddAtkMax || PoweredSharpAddAtkMax
|-
| <translate> Durability Up</translate> || Durability value boosted by: || SharpWeaponAddLifeMax || PoweredSharpAddLifeMax
|-
| Critical Hit || Last hit of a chain does double damage/staggers enemies || - || N/A
|-
| <translate> Shield Guard Up</translate> || '''Durability''' value boosted by: || SharpWeaponAddGuardMax || PoweredSharpWeaponAddGuardMax
|-
| <translate> Long Throw</translate> || Throw distance multiplied by: || - || PoweredSharpAddThrowMax
|-
| <translate> Multi-Shot Burst</translate> || Bow shoots multiple arrows: || - || 5
|-
| ''AddZoomRapid'' || Reticle zooms when aiming || - || Unknown {{check}}
|-
| <translate> Quick Shot</translate> || Firing rate multiplied by: || - || PoweredSharpAddRapidFireMin
|-
| <translate> ''AddSurfMaster''</translate> || Shield surfing friction multiplied by: || - || 0.2 (from [[GlobalParameter]]::ShieldSurfMasterFrictionRatio)
|}

<translate>

In summary, for amiibo weapons, a modifier always yields the highest possible value for that weapon as a bonus, except Quick Shot, which will use the ''lowest'' value.
No randomness is involved, aside from whether the Durability Up bonus comes from the AddLifeMax or AddGuardMax value.

== Enemies == 


When loading enemies, the game will always try to scale enemies.


However, the scaling function won't do anything if 'LevelSensorMode' is < 1 and will leave the enemy and any weapons they may hold unscaled.


Note: Enemies that are not in any upgrade list (such as elemental Lizalfos) will not be scaled, but their weapon can still receive upgrades if:
* 'LevelSensorMode' is non zero.
* Weapon point requirements are satisfied
* ''or'' the modifier tier is overridden using 'SharpWeaponJudgeType'.
[1.3.0] In Master Mode, '''all''' enemies are automatically ranked up one tier by default '''post scaling''', independently of 'LevelSensorMode'. [[Actor]]s can receive two additional parameters:
</translate>
{| class="wikitable"
! <translate> Parameter</translate>
! <translate> Default</translate>
! <translate> Description</translate>
|-
| IsHardModeActor
| false
| <translate> Controls whether an enemy only shows up in Master Mode.</translate>
|-
| DisableRankUpForHardMode
| false
| <translate> Controls whether the automatic rankup applies to an enemy.</translate>
|}
<translate>

In Master Mode, IsHardModeActor, DisableRankUpForHardMode and LevelSensorMode are combined on some actors to keep low-level enemies in the overworld (e.g. Red Bokoblin south of the Great Plateau). Enemies within Test of Strength Shrines (Dungeon070-Dungeon089 and Dungeon135) are not ranked up, [https://code.botw.link/uking/uking/src/Game/DLC/aocHardModeManager.cpp.html#_ZNK5uking3aoc15HardModeManager22isTestOfStrengthShrineEv HardModeManager::<dfn>rankUpEnemy</dfn>].

== Properties == 

=== <code>LevelSensorMode</code> === 
This [[actor]] property controls whether scaling is enabled for an enemy or weapon. Also applies to any weapons held by an enemy since 'scaleWeapon' is called when an enemy drops their weapon.


Note that this doesn't apply to weapons that are attached to a Hinox's necklace, because Hinoxes use a different underlying enemy actor which overrides the 'on weapon dropped' function and ignores 'LevelSensorMode'.

=== <code>SharpWeaponJudgeType</code> === 
This actor property controls the ''minimum'' modifier tier that a weapon can receive.


Internally and in assets such as [[Map unit|map units]], the following values are used for modifiers:
</translate>

{| class="wikitable"
! <translate> Value</translate>
! <translate> Description</translate>
|-
| 0
| <translate> '''None''': No modifiers.</translate>
|-
| 1
| <translate> '''RandomBlue''': Weapon will randomly get at least a blue modifier (with <code>weaponCommonSharpWeaponPer</code> being the probability).</translate>
|-
| 2
| <translate> '''Blue''': Weapon will get at least a blue modifier.</translate>
|-
| 3
| <translate> '''Yellow''': Weapon will get at least a yellow modifier.</translate>
|-
| 4
| <translate> '''NoneForced''' (chests only): Weapon will ''never'' spawn with any modifiers. ''This overrides regular scaling.''</translate>
|}

<translate>

If [[Difficulty scaling#LevelSensorMode|scaling]] is enabled, the weapon may receive modifiers from an even higher tier if point requirements are met.


Otherwise, the weapon will get modifiers from exactly the specified tier.


For example, 0 ('None') doesn't mean a weapon will never receive a modifier. It just means that the developers haven't forced the weapon to spawn with a blue/yellow modifier. If scaling requirements are satisfied, the weapon will receive blue or yellow modifiers.

== Scaling algorithm == 

=== <code>Ecosystem::LevelSensor::loadByml</code> === 


This function is called by <code>Ecosystem::init</code> from <code>ksys::InitializeApp</code>


Sets up byml structures for reading Ecosystem/[[LevelSensor.byml]].

=== <code>Ecosystem::LevelSensor::calculatePoints</code> === 


Called by [[PlacementMgr]] when spawning actors.


Calculates weapon and enemy scaling points using a list of flags and configuration values.


All flags that are referenced in the configuration file are of the form <code>Defeated_%s_Num</code>, but technically the configuration format allows for other flags to be specified.


Interestingly, the game calculates a single point value based on the kill counter flags but calculates two separate values for weapons and enemies with two different multipliers. This format makes it possible to easily change the scaling.


<source lang="c++">
float points = 0.0;
for (kill_flag : this->byml["flag"])
int kill_count = GameData::getIntegerFlag(kill_flag["name"]);
points += kill_count * kill_flag["point"];


this->points = points;
this->weapon_points = points * this->byml["setting"].Level2WeaponPower;
this->enemy_points = points * this->byml["setting"].Level2EnemyPower;
</source>


In practice, settings have never been modified. 1.5.0 (which will likely be the last game update) still has the same Level2WeaponPower and Level2EnemyPower.

=== <code>Ecosystem::LevelSensor::scaleWeapon</code> === 


Called from treasure chest code, enemy actors{{Check}}, <code>Ecosystem::LevelSensor::scaleActor</code>


Given a weapon name, its modifier and current point status, this function returns the weapon to actually spawn and the modifier to use (if possible).


If the algorithm fails to find an appropriate weapon that satisfies all conditions (point requirements, weapon series, modifier), the originally specified weapon and modifier will be used directly.


Pseudocode (1.0.0):


<source lang="c++">
bool Ecosystem::LevelSensor::scaleWeapon(const sead::SafeString& weapon_to_look_up,
WeaponModifier required_modifier,
const char** weapon_to_use_name,
WeaponModifier* modifier_to_use,
void* unknown)
{
// some checks using 'unknown' here which seems to be a pointer to the actor
//
for (weapon_table : this->byml["weapon"]) {
// find the first weapon entry for which the player has enough points
// with the specified name and modifier
i = -1;
for (j = 0; j < weapon_table["actors"].size; ++j) {
entry = weapon_table["actors"][j];
float points_for_next_transition = entry["value"];
//
if (this->weapon_points > points_for_next_transition &&
weapon_to_look_up == entry["name"] &&
convert_to_modifier(entry["plus"]) == required_modifier) {
i = j;
break;
}
}
//
if (i == -1)
continue;
//
do {
entry = weapon_table["actors"][i];
//
// not_rank_up means there is no link between weapons;
// this table is just used to look up modifiers.
// so go down the list until there are no more entries for the requested weapon
// or until we reach a modifier that requires more points.
if (weapon_table["not_rank_up"] && entry["name"] != weapon_to_look_up)
break;
//
// otherwise, just go down the list until we reach the end or a weapon which
// requires more points. this will possibly upgrade the weapon (e.g. Knight -> Royal).
if (this->weapon_points <= entry["value"])
break;
//
++i;
} while (i < weapon_table["actors"].size);
//
*weapon_to_use_name = entry["name"];
*modifier_to_use = convert_to_modifier(entry["plus"]);
return true;
}
return false; // cannot scale up
}
</source>

=== <code>Ecosystem::LevelSensor::scaleActor</code> === 


Analogous to <code>LevelSensor::scaleWeapon</code>.


Pseudocode (1.0.0):


<source lang="c++">
if (actor->params["LevelSensorMode"] < 1)
return false;
//
if (actor_name.contains("Enemy")) {
for (enemy_table : this->byml["enemy"]) {
i = -1;
for (j = 0; j < enemy_table["actors"].size; ++j) {
entry = enemy_table["actors"][j];
if (entry["name"] == actor_name && this->enemy_points > entry["value"]) {
i = j;
break;
}
}
//
if (i == -1)
continue;
//
do {
entry = enemy_table["actors"][i];
if (this->enemy_points <= entry["value"])
break;
++i;
} while (i < enemy_table["actors"].size);
//
*actor_to_use = entry["name"];
return true;
}
return false; // cannot scale up
}
//
if (actor_name.contains("Weapon")) {
weapon_name = actor->getWeaponName();
modifier = actor->params["SharpWeaponJudgeType"];
if (modifier == WeaponModifier::RandomBlue)
modifier = get_random_blue_modifier(actor->getWeaponName());
//
if (scaleWeapon(weapon_name, &weapon_to_use, &modifier_to_use)) {
actor->setProperty("SharpWeaponJudgeType", modifier_to_use);
*actor_to_use = weapon_to_use;
return true;
}
return false; // cannot scale up
}
</source>

== The Data == 


To make things easier to understand, here are links to:
* [https://docs.google.com/spreadsheets/d/e/2PACX-1vRSlyOD7FLAn1TUBn64Pu8Pld-WOfgcVByuywHMWvBTEV0j8potD1wkBs-MJJXf-gvEkpfItUCMqMk6/pubhtml kill point, enemy scaling and weapon scaling tables]
* an [https://objmap.zeldamods.org object map with scaling information].
This makes it possible to see both the required points for enemy/weapon upgrades, as well as all of the special cases extremely easily.

== Ganon Blights == 


Ganon blights also have varying difficulty but follow a different system. Their health is determined by the base HP (set in [[ActorParam/GeneralParamList|GeneralParamList]]) and blight defeat flags.


<source lang="c++">__int64 SiteBoss::getInitialHP(SiteBoss *this) // 0x71002D01F4
{
const int baseHp = Enemy::getInitialHP(this);
const int halfBaseHp = baseHp >> 1;
const bool dieGanonWind = hasFlag_Die_PGanonWind(0);
const bool dieGanonWater = hasFlag_Die_PGanonWater(0);
const bool dieGanonFire = hasFlag_Die_PGanonFire(0);
const bool dieGanonElectric = hasFlag_Die_PGanonElectric(0);
const int flags = this->siteBossFlags & 0xFFFFFFFC;
int multiplier;
if ( flags == 4 )
multiplier = 3;
else if ( flags == 8 )
multiplier = 4;
else
multiplier = dieGanonFire + dieGanonWind + dieGanonWater + dieGanonElectric;
return baseHp + multiplier * halfBaseHp;
}</source>


Effectively, this means that the first blight Link fights will have 800+0×400 = 800 HP, the second will have 800+1×400 = 1200 HP, the third 800+2×400 = 1600 HP and the last one 800+3×400 = 2000 HP.

=== Special case 1: Castle Blights === 


Castle blights have <code>IsRemainBoss</code> set to false in their root AI parameters (see [[AIDef:AI/SiteBossSpearRoot]] for example), which sets flag 4.


Thus, blights that are fought in the Castle always have 800+3×400 = 2000 HP regardless of story progression.


If flag 4 is set, the [[AIDef:Action/SiteBossDie]] code will NOT increment the "defeated" counter. This means castle blights do not give any scaling points.

=== Special case 2: DLC2 Blights === 


Illusory Realm blights possess the <code>EnemySiteBoss_R</code> actor tag. This causes flag 8 to be set. So they will always have 500+4×250 = 1500 HP.


Interestingly, the Windblight AI function doesn't check the actor tag but the actor name instead. For flag 8 to be set, the actor name must be <code>Enemy_SiteBoss_Bow_R</code>.

</translate>

<references />
[[Category:Internals{{#translation:}}]]
[[Category:Game mechanics{{#translation:}}]]

Save Files

2024-06-20T10:38:00Z

Savage13: Add weather save file information

<onlyinclude>
BotW can store up to 9 save states per profile, 6 for normal mode (1 manual save and 5 autosaves) and 2 for master mode (1 manual save and 1 autosave).
</onlyinclude>

==Folder Structure==
The content of the save folder is structured as following:

0
caption.jpg
caption.sav
game_data.sav
1
...
album
pict_000.jpg
pict_001.jpg
...
pict_book
Animal_Cassowary_A.jpg
Weapon_Sword_008.jpg
...
tracker
trackblock00.sav
trackblock01.sav
...
option.sav

The numbered folders each represent one save state.

===Options===
<code>option.sav</code> contains the settings set in the options menu (inverted camera, stick sensitivity etc.). The exact data stored here corresponds to the game flags defined in <code>Pack/Bootup.pack//GameData/savedataformat.ssarc///saveformat_*.bgsvdata</code>, where the <code>file_list</code> array's zero-index dictionary contains the <code>file_name</code> "option.sav"

===Album===
The album folder contains one JPG file for each entry in the in-game album, numbered in the order they were taken.

===Hyrule Compendium===
Each JPG file in the <code>pict_book</code> folder corresponds to one entry in the Hyrule Compendium. The name of each file is the internal name of the given item, weapon or animal. Do note that the compendium is not directly tied to a specific save state, meaning the images are shared between all saves.

===Save State===
Each save state contains 3 files:
* caption.jpg A screenshot taken at the time of saving.
* caption.sav Contains a small amount of data for each save that is displayed in the save select screen (e.g. time and location). The exact data stored here corresponds to the game flags defined in <code>Pack/Bootup.pack//GameData/savedataformat.ssarc///saveformat_*.bgsvdata</code>, where the <code>file_list</code> array's zero-index dictionary contains the <code>file_name</code> "caption.sav"
* game_data.sav The data for each save state. The exact data stored here corresponds to the game flags defined in <code>Pack/Bootup.pack//GameData/savedataformat.ssarc///saveformat_*.bgsvdata</code>, where the <code>file_list</code> array's zero-index dictionary contains the <code>file_name</code> "game_data.sav"

==.sav Folder Format==
All data in these files is stored as little endian on Switch and as big endian on Wii U.

A save file (with the exception of files in the tracker folder) starts with the following header:
{| class="wikitable"
!Offset !! Size !! Description
|-
| 0x00 || 4 || '''version''': Version of the game that created the save file.
|-
|0x04 || 4 || '''marker''': Always 0xFFFFFFFF.
|-
|0x08 || 4 || '''unknown''': Always 0x1.
|}

Versions:

{| class="wikitable"
! Game version !! Save version
|-
| 1.0.0 || 0x24E2
|-
| 1.1.0 || 0x24EE
|-
| 1.1.1 ||
|-
| 1.1.2 ||
|-
| 1.2.0 || 0x2588
|-
| 1.3.0 || 0x29C0
|-
| 1.3.1 || 0x2A46
|-
| 1.3.3 || 0x3EF8
|-
| 1.3.4 || 0x3EF9
|-
| 1.4.0 || 0x471A
|-
| 1.4.1 || 0x471A
|-
| 1.5.0 || 0x471B
|-
| 1.6.0 || 0x471E
|}

The data after the header is comprised of 8-byte chunks:

{| class="wikitable"
!Offset !! Size !! Description
|-
| 0x00 || 4 || '''id''': ID of the data being stored, crc32 of the internal key
|-
|0x04 || 4 || '''value'''
|}

In <code>Pack/Bootup.pack//GameData/savedataformat.ssarc///saveformat_*.bgsvdata</code>, the game stores a mapping for each ID to the corresponding entry name. This name is then further defined in one of the files in <code>Pack/Bootup.pack//GameData/gamedata.ssarc//*</code>, depending on its data type.

Strings are stored with the maximum possible number of characters (e.q. 256 characters for strings defined in string256_data_0.bgdata) and are broken up into 4-byte parts. These are then stored in sequential chunks with the ID repeating for each chunk.

For arrays the data is also stored in sequential chunks, each with an identical ID. The horse names for example will take up 96 chunk with the ID 0x7B74E117 in the save file, 6 names with 16 chunks (= 64 characters) for each name.

Data types for <code>value</code> include bool, int32, float32, string, string64, string256, vector2f, vector3f, vector4, bool_array, int32_array, float32_array, string64_array, string256_array, vector2f_array, and vector3f_array. Value types are read as, and therefore must correspond to, the type defined in the <code>Pack/Bootup.pack//GameData/gamedata.ssarc/*</code> in the key of the main byml dictionary where the <code>id</code> is found. (Note that, in the vanilla game, this also corresponds to the name of the file, itself, but this relationship is not strict and therefore may not be the case for files added by mods.)

Inventory items are stored in <code>PorchItem</code> with a maximum of 420 internal string identifiers, e.g. <code>Weapon_Sword_023</code>. Associated arrays of <code>PorchEquip</code>: boolean and <code>PorchItem_Value1</code>: int32 store if the item is equipped and its current durability * 100 or item count. Swords, Bows and Shields also store their modifier key in <code>PorchSword_FlagSp</code>: uint32 and modifier value <code>PorchSword_ValueSp</code>: int32. Similar Flag and Value exist for the Bows and Shields. <code>FlagSp</code> modifiers can take any or all of the following values.
{| class="wikitable"
|+
!Modifier
!Value
|-
|AttackUp
|0x1
|-
|DurabilityUp
|0x2
|-
|CriticalHit
|0x4
|-
|LongThrow
|0x8
|-
|MultiShot
|0x10
|-
|Zoom
|0x20
|-
|QuickShot
|0x40
|-
|SurfMaster
|0x80
|-
|Enchanced Modifer
|0x80000000
|}
Associated data with Cooked Items are held in <code>CookEffect0</code>: vector2f, <code>CookEffect1</code>: vector2f, and <code>StaminaRecover</code>: vector2f arrays. Values within these arrays are
{| class="wikitable"
|+
!Save Key
!Index
!Description
|-
|CookEffect0
|0
|EffectType
|-
|CookEffect0
|1
|EffectLevel
|-
|CookEffect1
|0
|Cooked Item SellingPrice
|-
|CookEffect1
|1
|Never set
|-
|StaminaRecover
|0
|HitPointRecover
|-
|StaminaRecover
|1
|EffectLevel
|}
Weather data with [[WorldMgr#Weather types|type data]] are found in <code>climateWeather</code> : int32_array, <code>climateWeather2</code>: int32_array and <code>climateWeather3</code> : int32_array. These values contain the weather for the next three in-game days. Arrays are 20 values in length map directly to climate values of each [[Map area]]. Each int32 value contains 6 packed [[WorldMgr#Weather types|WorldMgr]] weather types that each are 4 bits long (nibble, 0x0-0xF). These weather types identify are for each 4 hour long period during the day.<references />
[[Category:File_formats]]

Talk:Save Files

2024-06-19T22:24:43Z

Savage13:

== What belongs here ==

Given that this page is mostly about the format of the save files, I'm not sure that it makes sense to have info about data contained within that format (e.g. PorchItem) as that is defined in, and created by, the game data and simply dumped into the existing format.

I don't have any better place to put it, though, so /shrug, I guess? The existing game data pages deal with formats of the data and the files, as well, not specific data contained within them. PorchItem should probably best go into a new Inventory page, but I don't know if it matters enough to bother.

--[[User:Ginger|Ginger]] ([[User talk:Ginger|talk]]) 22:20, 19 June 2024 (UTC)

I also have details about Modifiers for the Cooked Meais and Weather related data. I feel that information for Cooked Meals is contained on another page, but the Weather/Climate data is not present anywhere else. The weather data is not as straight foward as one would hope.

- savage13 22:20, 19 June 2024 (UTC)

Save Files

2024-06-19T21:23:35Z

Savage13: Add description of Save data and Inventory data

<onlyinclude>
BotW can store up to 9 save states per profile, 6 for normal mode (1 manual save and 5 autosaves) and 2 for master mode (1 manual save and 1 autosave).
</onlyinclude>

==Folder Structure==
The content of the save folder is structured as following:

0
caption.jpg
caption.sav
game_data.sav
1
...
album
pict_000.jpg
pict_001.jpg
...
pict_book
Animal_Cassowary_A.jpg
Weapon_Sword_008.jpg
...
tracker
trackblock00.sav
trackblock01.sav
...
option.sav

The numbered folders each represent one save state.

===Options===
<code>option.sav</code> contains the settings set in the options menu (inverted camera, stick sensitivity etc.).

===Album===
The album folder contains one JPG file for each entry in the in-game album, numbered in the order they were taken.

===Hyrule Compendium===
Each JPG file in the <code>pict_book</code> folder corresponds to one entry in the Hyrule Compendium. The name of each file is the internal name of the given item, weapon or animal. Do note that the compendium is not directly tied to a specific save state, meaning the images are shared between all saves.

===Save State===
Each save state contains 3 files:
* caption.jpg A screenshot taken at the time of saving.
* caption.sav Contains a small amount of data for each save that is displayed in the save select screen (e.g. time and location).
* game_data.sav The data for each save state.

==.sav Folder Format==
All data in these files is stored as little endian on Switch and as big endian ion Wii U.

A save file (with the exception of files in the tracker folder) starts with the following header:
{| class="wikitable"
!Offset !! Size !! Description
|-
| 0x00 || 4 || '''version''': Version of the game that created the save file.
|-
|0x04 || 4 || '''marker''': Always 0xFFFFFFFF.
|-
|0x08 || 4 || '''unknown''': Always 0x1.
|}

Versions:

{| class="wikitable"
! Game version !! Save version
|-
| 1.0.0 || 0x24E2
|-
| 1.1.0 || 0x24EE
|-
| 1.1.1 ||
|-
| 1.1.2 ||
|-
| 1.2.0 || 0x2588
|-
| 1.3.0 || 0x29C0
|-
| 1.3.1 || 0x2A46
|-
| 1.3.3 || 0x3EF8
|-
| 1.3.4 || 0x3EF9
|-
| 1.4.0 || 0x471A
|-
| 1.4.1 || 0x471A
|-
| 1.5.0 || 0x471B
|-
| 1.6.0 || 0x471E
|}

The data after the header is comprised of 8-byte chunks:

{| class="wikitable"
!Offset !! Size !! Description
|-
| 0x00 || 4 || '''id''': ID of the data being stored, crc32 of the internal key
|-
|0x04 || 4 || '''value'''
|}

In <code>Pack/Bootup.pack/GameData/savedataformat.ssarc/saveformat_*.bgsvdata</code> the game stores a mapping for each ID to the corresponding entry name. This name is then further defined in one of the files in <code>Pack/Bootup.pack/GameData/gamedata.ssarc/*</code>, depending on its data type.

Strings are stored with the maximum possible number of characters (e.q. 256 characters for strings defined in string256_data_0.bgdata) and are broken up into 4-byte parts. These are then stored in sequential chunks with the ID repeating for each chunk.

For arrays the data is also stored in sequential chunks, each with an identical ID. The horse names for example will take up 96 chunk with the ID 0x7B74E117 in the save file, 6 names with 16 chunks (= 64 characters) for each name.

Data types for <code>value</code> include bool, int32, float32, string, string64, string256, vector2f, vector3f, vector4, bool_array, int32_array, float32_array, string64_array, string256_array, vector2f_array, and vector3f_array.

Inventory items are stored in <code>PorchItem</code> with a maximum of 420 internal string identifiers, e.g. <code>Weapon_Sword_023.</code>Associated arrays of <code>PorchEquip</code>: boolean and <code>PorchItem_Value1: int32</code> store if the item is equipped and its current durability * 100 or item count. Swords, Bows and Shields also store their modifier key in <code>PorchSword_FlagSp: in32</code> and modifier value <code>PorchSword_ValueSp: int32</code>. Similar Flag and Value exist for the Bows and Shields. <code>FlagSp</code> modifiers can take any or all of the following values.
{| class="wikitable"
|+
!Modifier
!Value
|-
|AttackUp
|0x1
|-
|DurabilityUp
|0x2
|-
|CriticalHit
|0x4
|-
|LongThrow
|0x8
|-
|MultiShot
|0x10
|-
|Zoom
|0x20
|-
|QuickShot
|0x40
|-
|SurfMaster
|0x80
|-
|Enchanced Modifer
|0x80000000
|}
Associated data with Cooked Items are held in <code>CookEffect0: vector2f</code>, <code>CookEffect1: vector2f,</code> and <code>StaminaRecover: vector2f</code> arrays. Values within these arrays are
{| class="wikitable"
|+
!Save Key
!Index
!Description
|-
|CookEffect0
|0
|EffectType
|-
|CookEffect0
|1
|EffectLevel
|-
|CookEffect1
|0
|Cooked Item SellingPrice
|-
|CookEffect1
|1
|Never set
|-
|StaminaRecover
|0
|HitPointRecover
|-
|StaminaRecover
|1
|EffectLevel
|}
<references />
[[Category:File_formats]]