ReSkate/Engine/Vfs/mod_merge_combine.cpp

#include "mod_merge_internal.h"
#include "Engine/Resource/cas_codec.h"
#include "Engine/Resource/ebx_document.h"
#include "Engine/Resource/bundle_ref_table.h"
#include "Engine/Resource/ebx_merge.h"
#include "Engine/Resource/ebx_writer.h"
#include "Engine/Resource/shader_lookup.h"
#include "Engine/Core/Platform/path_text.h"

#include <algorithm>
#include <functional>
#include <map>
#include <set>
#include <unordered_map>
#include <unordered_set>
#include <stdexcept>
#include <tuple>

namespace dingosdk::mods::detail {
namespace {
// The first bytes of a payload, for a log line: whether they look like a
// bundle manifest, a compressed block or nothing at all tells a reader what a
// mod really put where its manifest was expected.
std::string hex_preview(std::span<const std::byte> bytes) {
    static constexpr char digits[] = "0123456789abcdef";
    std::string text;
    for (const auto value : bytes) {
        const auto byte = static_cast<unsigned>(value);
        if (!text.empty()) text += ' ';
        text += digits[byte >> 4];
        text += digits[byte & 15];
    }
    return text.empty() ? std::string("(empty)") : text;
}

struct Asset {
    fb::BundleAsset asset;
    fb::BundleFileInfo file;
    bool base{};
    const std::string* mod{};   // whose copy of the bundle it came in; null for the game's
    // For a chunk: where its record is in the chunk metadata of the copy this version
    // of it came in, and where the game's copy lists the chunk (merge_chunk_metadata).
    ChunkRecord record;
};

// Where one contributor's copy of an asset lives, so conflicting copies can be
// fetched and combined later.
struct Contribution {
    const fs::path* root{};    // the source's folder, in `sources` or baseRoot: neither moves while combine runs
    fb::BundleFileInfo file;   // still pointing at the archive it came from
    fb::Sha1 sha1;
    std::vector<std::byte> resourceMeta;
    bool base{};
};

// Region files run parallel to the manifest's ebx, then resources, then chunks.
std::vector<Asset> flatten(const fb::BundleRegion& region, const fb::BinaryBundle& manifest,
                           std::size_t first = 0) {
    std::vector<Asset> result;
    result.reserve(manifest.ebx.size() + manifest.resources.size() + manifest.chunks.size());
    const auto take = [&](const std::vector<fb::BundleAsset>& list) {
        for (const auto& asset : list) {
            const auto index = first + result.size();
            if (index >= region.files.size())
                throw std::runtime_error("Bundle region has fewer files than its manifest lists");
            result.push_back({asset, region.files[index]});
        }
    };
    take(manifest.ebx);
    take(manifest.resources);
    take(manifest.chunks);
    return result;
}

std::string asset_key(const fb::BundleAsset& asset) {
    return std::to_string(static_cast<int>(asset.kind)) + ':' +
        (asset.kind == fb::AssetKind::chunk ? asset.guid.string() : lower(asset.name));
}

// The game's item lists (items/itemmastercollection, a season's
// 0.30.0_itemcollection), which every cosmetic mod adds its items to. The game
// reads each entry of one at startup without checking it, so an entry naming an
// item that is not loaded is a crash on every launch, not a missing item.
bool item_list_name(std::string_view name) {
    const auto text = lower(name);
    return text.starts_with("items/") && text.find("collection") != std::string::npos;
}
constexpr std::string_view item_list_type = "delmaritemcollectionasset";

// Some bundles carry no inline manifest: their region only lists placements,
// so their assets cannot be named and the bundle can only be passed through
// whole, with the highest-priority copy winning.
struct BundleState {
    bool opaque{};
    // The mod whose copy is being carried whole because it could not be read,
    // and why; its additions vanish if a readable copy later takes over.
    std::string opaqueBy, opaqueWhy;
    // The manifest was read out of cas and has to be written back the same way.
    bool casBacked{};
    std::uint32_t manifestChunk{};
    std::vector<Asset> assets;
    std::vector<fb::BundleFileInfo> files;
    // Each copy's chunk metadata; copies that carry the same list share an entry.
    // Every chunk remembers its record in one of these (Asset::record), and the
    // list is written again when the manifest is rebuilt (merge_chunk_metadata).
    std::vector<std::vector<std::byte>> metadata;
    // Which of those is the game's own, and the chunks the game's copy lists.
    std::size_t gameMetadata{ChunkRecord::none};
    std::vector<fb::Guid> shippedChunks;
    // Keyed position of each asset, so replacing one stays constant time: these
    // bundles hold tens of thousands of entries. Hashed, here and below: the keys
    // are asset paths that share long beginnings, which an ordered map compares
    // byte by byte at every step, and nothing reads these in key order.
    std::unordered_map<std::string, std::size_t> seen;
    // Each source's copy of an asset, base first; a mod's copy equal to the base's first is left out.
    std::unordered_map<std::string, std::vector<Contribution>> history;
    // The base's own sha1 for each asset, so a mod that merely carries an
    // unchanged copy can be told apart from one that changed it.
    std::unordered_map<std::string, fb::Sha1> baseSha;
    // Assets a mod added that a higher-priority mod's different asset of the
    // same name then replaced: the key, and the sha1 of the copy that went.
    std::vector<std::pair<std::string, fb::Sha1>> displaced;

    // Whether `sha1` is the game's first copy of `key`: the copy edits are combined onto.
    [[nodiscard]] bool matches_game_copy(const std::string& key, const fb::Sha1& sha1) const {
        const auto copies = history.find(key);
        return copies != history.end() && copies->second.front().base && copies->second.front().sha1 == sha1;
    }
};

// The guids of the EBX a merged bundle ends up holding, to tell whether what a
// list entry names is in it. Read on first use: the assets mods added, which is
// where a mod's entry nearly always points, and the game's own thousands only
// when one of those is not the answer.
class HeldAssets final {
public:
    using Decode = std::function<std::vector<std::byte>(const Contribution&)>;
    HeldAssets(const BundleState& state, Decode decode) : state_(state), decode_(std::move(decode)) {}

    [[nodiscard]] bool holds(const fb::Guid& guid) {
        if (!added_) { read(false); added_ = true; }
        if (guids_.contains(guid)) return true;
        if (!shipped_ && !unsure_) { read(true); shipped_ = true; }
        // A copy that could not be read may be the very one asked about.
        return unsure_ || guids_.contains(guid);
    }

    // The asset that took the place of the one with this guid, when it was a
    // mod's addition another mod's of the same name replaced; null otherwise.
    [[nodiscard]] const Asset* replacement(const fb::Guid& guid) {
        if (!displacedRead_) {
            displacedRead_ = true;
            for (const auto& [key, sha1] : state_.displaced) {
                const auto copies = state_.history.find(key);
                const auto at = state_.seen.find(key);
                if (copies == state_.history.end() || at == state_.seen.end()) continue;
                for (const auto& copy : copies->second) {
                    if (copy.sha1 != sha1) continue;
                    try {
                        displaced_.emplace(fb::ebx::read_file_guid(decode_(copy)), &state_.assets[at->second]);
                    } catch (const std::exception&) {}
                    break;
                }
            }
        }
        const auto found = displaced_.find(guid);
        return found == displaced_.end() ? nullptr : found->second;
    }

private:
    void read(bool shipped) {
        for (const auto& asset : state_.assets) {
            if (asset.asset.kind != fb::AssetKind::ebx) continue;
            const auto key = asset_key(asset.asset);
            if (state_.baseSha.contains(key) != shipped) continue;
            // The copy the bundle keeps. One combined from several mods' is none
            // of theirs, and has the guid of the game's it was combined onto.
            const Contribution* kept{};
            if (const auto copies = state_.history.find(key); copies != state_.history.end())
                for (const auto& copy : copies->second) {
                    if (copy.sha1 == asset.asset.sha1) { kept = &copy; break; }
                    if (copy.base) kept = &copy;
                }
            try {
                if (!kept) throw std::runtime_error("no copy to read");
                guids_.insert(fb::ebx::read_file_guid(decode_(*kept)));
            } catch (const std::exception&) {
                unsure_ = true;
            }
        }
    }

    const BundleState& state_;
    Decode decode_;
    std::set<fb::Guid> guids_;
    std::map<fb::Guid, const Asset*> displaced_;
    bool added_{}, shipped_{}, unsure_{}, displacedRead_{};
};

// Rebuilds the manifest and the matching placement list in the order the
// format requires: ebx, then resources, then chunks.
void build_manifest(const std::vector<Asset>& assets, std::span<const std::byte> chunkMetadata,
                    fb::BinaryBundle& manifest, std::vector<fb::BundleFileInfo>& files) {
    manifest.chunkMetadata.assign(chunkMetadata.begin(), chunkMetadata.end());
    files.reserve(assets.size());
    const auto emit = [&](fb::AssetKind kind, std::vector<fb::BundleAsset>& into) {
        for (const auto& entry : assets) {
            if (entry.asset.kind != kind) continue;
            into.push_back(entry.asset);
            files.push_back(entry.file);
        }
    };
    emit(fb::AssetKind::ebx, manifest.ebx);
    emit(fb::AssetKind::resource, manifest.resources);
    emit(fb::AssetKind::chunk, manifest.chunks);
}

std::span<const unsigned char> unsigned_bytes(std::span<const std::byte> data) {
    return {reinterpret_cast<const unsigned char*>(data.data()), data.size()};
}

} // namespace

std::vector<std::byte> merge_chunk_metadata(std::span<const std::vector<std::byte>> lists,
                                            std::span<const ChunkRecord> chunks, std::size_t game,
                                            std::span<const fb::Guid> shipped) {
    // A bundle with no chunks has nothing to describe; what the first copy has stays.
    if (chunks.empty()) return lists.empty() ? std::vector<std::byte>{} : lists.front();
    const bool shippedList = game < lists.size() && !lists[game].empty();

    // Nothing moved: nearly every bundle is this, and its list is not read at all.
    // With the game's list, every chunk is the game's own where the game lists it;
    // without one, every chunk keeps one copy's record at its own place.
    const auto first = shippedList ? game : chunks.front().copy;
    bool whole = first < lists.size() && (!shippedList || chunks.size() == shipped.size());
    for (std::size_t index = 0; whole && index < chunks.size(); ++index)
        whole = chunks[index].copy == first && chunks[index].index == index &&
                (!shippedList || chunks[index].shipped == index);
    if (whole) return lists[first];

    std::vector<std::optional<native_db::Node>> read(lists.size());
    const auto list = [&](std::size_t copy) -> const native_db::Node* {
        if (copy >= lists.size() || lists[copy].empty()) return nullptr;
        // A level's root bundle has thousands of chunks; every value takes a byte at least.
        if (!read[copy])
            read[copy] = native_db::read(unsigned_bytes(lists[copy]), "chunk metadata", nullptr,
                                         {.unique_fields = false, .max_entries = lists[copy].size()});
        return &*read[copy];
    };
    const auto row = [&](std::size_t copy, std::size_t index) -> const native_db::Node* {
        const auto* from = list(copy);
        return from && index < from->children.size() ? &from->children[index] : nullptr;
    };

    // The game's list, when it is the kind this is written as: a record for each of
    // the game's chunks, in the order of their guids.
    const auto* original = shippedList ? list(game) : nullptr;
    if (original && original->children.size() != shipped.size()) original = nullptr;
    std::vector<std::size_t> place(shipped.size());   // where each of the game's chunks has its record
    if (original) {
        std::vector<std::size_t> order(shipped.size());
        for (std::size_t index = 0; index < order.size(); ++index) order[index] = index;
        std::ranges::sort(order, [&](std::size_t left, std::size_t right) { return shipped[left] < shipped[right]; });
        for (std::size_t at = 0; at < order.size(); ++at) place[order[at]] = at;
    }

    std::vector<native_db::Node> records;
    std::vector<bool> described(chunks.size());
    records.reserve(chunks.size());
    for (std::size_t index = 0; index < chunks.size(); ++index) {
        const auto& chunk = chunks[index];
        const auto* written = row(chunk.copy, chunk.index);
        const native_db::Node* kept = written;
        std::optional<native_db::Node> changed;
        if (original && chunk.shipped < shipped.size()) {
            kept = &original->children[place[chunk.shipped]];
            // A mod's version of the chunk: its tool started from the game's list and wrote a
            // record where the chunk is listed, in place of whatever the game has there. The
            // first mip it gave is the one the mod's texture has; the rest of it is not the
            // chunk's (the hash is another chunk's, or empty).
            const auto* before = chunk.index < original->children.size() ? &original->children[chunk.index] : nullptr;
            if (chunk.copy != game && written && (!before || native_db::write(*written) != native_db::write(*before)))
                if (const auto* meta = written->field("meta"))
                    if (const auto* mip = meta->field("firstMip")) {
                        changed = *kept;
                        if (auto* own = changed->field("meta")) {
                            if (auto* current = own->field("firstMip")) *current = *mip;
                            else own->children.push_back(*mip);
                            kept = &*changed;
                        }
                    }
        }
        described[index] = kept != nullptr;
        records.push_back(kept ? *kept : native_db::Node{});
    }
    const native_db::Node* shape = original;
    for (std::size_t copy = 0; !shape && copy < read.size(); ++copy)
        if (read[copy]) shape = &*read[copy];
    if (!shape) return {};   // no copy has a list at all
    // A chunk no list describes still takes up its place, with a record that says nothing.
    native_db::Node blank;
    blank.type = 2;
    for (std::size_t index = 0; index < records.size(); ++index)
        if (described[index]) {
            blank = records[index];
            blank.children.clear();
            break;
        }
    for (std::size_t index = 0; index < records.size(); ++index)
        if (!described[index]) records[index] = blank;

    // As the game writes it: by the chunks' guids. Only a bundle whose own list in the
    // game is of another kind keeps the order its chunks are listed in.
    std::vector<std::size_t> order(chunks.size());
    for (std::size_t index = 0; index < order.size(); ++index) order[index] = index;
    if (original || !shippedList)
        std::ranges::stable_sort(order, [&](std::size_t left, std::size_t right) { return chunks[left].guid < chunks[right].guid; });
    auto merged = *shape;
    merged.children.clear();
    merged.children.reserve(records.size());
    for (const auto index : order) merged.children.push_back(std::move(records[index]));
    const auto bytes = native_db::write(merged);
    const auto* data = reinterpret_cast<const std::byte*>(bytes.data());
    return {data, data + bytes.size()};
}

// One superbundle, combined across every mod that ships it. `used` collects the
// patch archives the result actually references, keyed by install chunk, so the
// layout declares those and only those.
fb::TocDocument combine(const fs::path& baseToc, const fs::path& baseRoot,
                        std::vector<Source>& sources, MergeReport& report,
                        const std::string& relative, ArchiveUse& used, CasStore& store,
                        std::uint16_t manifestArchive, const fs::path& gameRoot, const GridPlan& grid,
                        const AssetOverrides& overrides) {
    fb::TocDocument merged;
    merged.flags = 3;

    std::map<std::string, fb::TocDocument, std::less<>> baseHolder;
    const fb::TocDocument* base{};
    std::error_code error;
    if (fs::is_regular_file(baseToc, error) && !error) {
        baseHolder.emplace(relative, fb::read_toc(read_file(baseToc)));
        base = &baseHolder.at(relative);
    }

    // Only bundles more than one mod ships need their contents merged; the rest
    // pass through as they arrived, which keeps the risky path narrow.
    std::map<std::string, std::size_t, std::less<>> providers;
    for (const auto& source : sources)
        for (const auto& bundle : source.toc.bundles) ++providers[lower(bundle.name)];

    // Bundle order follows the base, then anything a mod introduces.
    std::vector<std::string> order;
    std::map<std::string, BundleState, std::less<>> states;

    // Per mod: bundles whose payloads lie outside the archives the mod ships.
    struct ArchiveFault {
        std::size_t bundles{}, missing{}, overrun{};
        std::string example;
    };
    std::map<std::string, ArchiveFault> archiveFaults;
    // Mods whose added assets went into a copy here: their added chunks come too.
    std::set<std::string> addedFrom;
    // The mods absorbed so far, so each asset can say whose copy it is.
    std::set<std::string> owners;
    // Every EBX a mod added to one of the game's bundles, by its document's guid
    // and with the bundle it was added to: what a changed list names is looked
    // up here, whichever bundle the mod put it in.
    std::multimap<fb::Guid, std::pair<const std::string*, const AssetAddition*>> addedByGuid;
    // The resource a mod added to a bundle under a name, by bundle, mod and name.
    std::map<std::tuple<std::string, std::string, std::string>, const AssetAddition*> companions;
    for (const auto& [bundleName, list] : overrides.added)
        for (const auto& addition : list) {
            if (addition.asset.kind == fb::AssetKind::ebx)
                addedByGuid.emplace(addition.file, std::pair{&bundleName, &addition});
            else if (addition.asset.kind == fb::AssetKind::resource)
                companions.emplace(std::tuple{bundleName, addition.mod, lower(addition.asset.name)}, &addition);
        }
    // The carried place each addition got in this superbundle, by install chunk.
    std::map<std::pair<std::uint32_t, const AssetAddition*>, fb::BundleFileInfo> carriedAt;
    // The names any mod changed, to rule the rest out without a copy of each (name_hash).
    std::unordered_set<std::uint64_t> changedNames, scriptNames;
    for (const auto& [name, versions] : overrides.changed) changedNames.insert(name_hash(name));
    for (const auto& [name, versions] : overrides.scripts) scriptNames.insert(name_hash(name));

    const auto absorb = [&](const fb::TocBundle& bundle, const ArchivePlacement* placement,
                            bool isBase, const fs::path& root) {
        const auto key = lower(bundle.name);
        auto region = fb::read_bundle_region(bundle.region);
        const auto provider = providers.find(key);
        const auto shared = provider != providers.end() && provider->second > 1;
        const auto modName = isBase ? std::string("base") : path_utf8(root.filename());
        // The bundle holding the live material grid is rebuilt to carry the
        // combined one, and a mod whose surfaces moved has its collision
        // renumbered; both need the asset list even where one mod ships it.
        const auto gridBundle = !grid.payload.empty() && key == grid.bundle;
        const auto renumber = !isBase && grid.rewrites(modName);
        // A mod's copies of assets another mod changed take that change.
        const auto propagate = !isBase && !overrides.empty();
        // Reading the manifest only to look for such copies is optional: a
        // bundle that cannot be read that way just passes through as it is.
        const auto needed = shared || gridBundle || renumber;

        // A mod's payloads have to lie inside the archives it ships. A bundle
        // pointing past the end of one, or into one that is not there, means
        // the folder was truncated or copied from a different build, and the
        // level would wait for data that never arrives.
        if (!isBase) {
            std::size_t missing{}, overrun{};
            std::string example;
            for (const auto& file : region.files) {
                if (!file.location.patch) continue;
                const auto size = store.archive_size(root, file.location);
                if (!size) {
                    ++missing;
                    if (example.empty()) example = store.describe(file.location) + " is not in the mod folder";
                } else if (static_cast<std::uint64_t>(file.offset) + file.size > *size) {
                    ++overrun;
                    if (example.empty())
                        example = std::to_string(file.size) + " bytes at byte " + std::to_string(file.offset) +
                            " lie past the end of " + store.describe(file.location) + " (" +
                            std::to_string(*size) + " bytes long)";
                }
            }
            if (missing || overrun) {
                auto& fault = archiveFaults[modName];
                ++fault.bundles;
                fault.missing += missing;
                fault.overrun += overrun;
                if (fault.example.empty()) fault.example = bundle.name + ": " + example;
            }
        }

        // Read a cas-backed manifest before shifting, while the placement still
        // points at the archive it came from.
        fb::BinaryBundle casManifest;
        bool casBacked{};
        // Why the manifest could not be read, for the problem recorded once the
        // consequence for this copy is known.
        std::string manifestFailure;
        // Best effort: if the manifest cannot be recovered the bundle falls back
        // to being passed through whole, which is what it did before in-bundle
        // merging existed. Losing a merge is far better than losing every mod.
        // Studio writes the manifest as the region's first file, but a mod built
        // by another tool or an older build may keep it elsewhere, so every small
        // file is a candidate; a placement outside the patch lives in the base.
        if (region.inlineManifest.empty() && (needed || propagate) && !region.files.empty()) {
            std::string firstFailure;
            constexpr std::uint32_t largestManifest = 32u << 20;
            const auto expected = region.files.size() - 1;
            for (std::size_t index = 0; index < region.files.size() && !casBacked; ++index) {
                const auto& candidate = region.files[index];
                if (candidate.size > largestManifest) continue;
                try {
                    auto manifest = store.read_manifest(candidate.location.patch ? root : baseRoot,
                                                        candidate.location, candidate.offset,
                                                        candidate.size, gameRoot);
                    const auto assets = manifest.ebx.size() + manifest.resources.size() +
                        manifest.chunks.size();
                    if (assets != expected)
                        throw std::runtime_error("manifest lists " + std::to_string(assets) +
                            " assets but the region holds " + std::to_string(region.files.size()) +
                            " files");
                    casManifest = std::move(manifest);
                    casBacked = true;
                    if (index != 0)
                        report.notes.push_back(modName + ": " + bundle.name + ": manifest found at file " +
                            std::to_string(index) + " of the region");
                } catch (const std::exception& failure) {
                    if (firstFailure.empty()) firstFailure = failure.what();
                }
            }
            if (!casBacked && needed) {
                // Say where the manifest was looked for and what is really
                // there, so a broken mod can be diagnosed from the log alone.
                const auto& first = region.files.front();
                const auto& firstRoot = first.location.patch ? root : baseRoot;
                std::string where = "file 0 of " + std::to_string(region.files.size()) + " is " +
                    std::to_string(first.size) + " bytes at byte " + std::to_string(first.offset) + " of " +
                    store.describe(first.location) + (first.location.patch ? "" : " in the base game");
                if (const auto archive = store.archive_size(firstRoot, first.location); !archive) {
                    where += ", which is missing";
                } else if (static_cast<std::uint64_t>(first.offset) + first.size > *archive) {
                    where += ", which is only " + std::to_string(*archive) + " bytes long";
                } else {
                    try {
                        const auto head = store.read(firstRoot, first.location, first.offset,
                                                     std::min<std::uint32_t>(first.size, 8));
                        where += ", starting " + hex_preview(head);
                    } catch (const std::exception&) {}
                }
                manifestFailure = "its manifest could not be read (" + firstFailure + "); " + where;
                report.notes.push_back(modName + ": " + bundle.name + ": " + manifestFailure);
            }
        }

        // Collision renumbered for the combined material grid goes into the
        // merged patch now, while the placements still point into the mod's
        // own archives.
        std::map<std::size_t, fb::BundleFileInfo> renumbered;
        if (renumber && casBacked) {
            const auto first = 1 + casManifest.ebx.size();
            std::size_t failed{};
            std::string failure;
            for (std::size_t index = 0; index < casManifest.resources.size(); ++index) {
                auto& asset = casManifest.resources[index];
                if (asset.resourceType != fb::material_grid::physicsResourceType) continue;
                const auto* slots = grid.remap_for(modName, asset.name);
                if (!slots || first + index >= region.files.size()) continue;
                try {
                    const auto& file = region.files[first + index];
                    auto payload = fb::decode_cas(store.read(file.location.patch ? root : baseRoot, file.location,
                                                             file.offset, file.size), {gameRoot});
                    if (!fb::material_grid::remap_physics(payload, *slots)) continue;
                    renumbered[first + index] = store.write(file.location.installChunk, manifestArchive,
                                                            fb::encode_cas(payload, {gameRoot}));
                    asset.sha1 = sha1_of(payload);
                    asset.originalSize = payload.size();
                } catch (const std::exception& error) {
                    if (!failed++) failure = asset.name + ": " + error.what();
                }
            }
            if (!renumbered.empty())
                report.notes.push_back(modName + ": " + bundle.name + ": " + std::to_string(renumbered.size()) +
                    " collision resource(s) renumbered for the combined material grid");
            if (failed)
                report.notes.push_back(modName + ": " + bundle.name + ": " + std::to_string(failed) +
                    " collision resource(s) could not be renumbered, e.g. " + failure);
        }

        // The mod's unchanged copies of assets another mod changed: the change
        // goes into the merged patch, next to this bundle's other files.
        std::map<std::size_t, fb::BundleFileInfo> overridden;
        // The documents those changes refer to: the ones a mod added come along below.
        std::set<fb::Guid> wanted;
        if (propagate && (casBacked || !region.inlineManifest.empty())) {
            std::string example;
            auto manifest = casBacked ? std::move(casManifest) : fb::read_binary_bundle(region.inlineManifest);
            const auto replace = [&](std::vector<fb::BundleAsset>& assets, const auto& changes,
                                     const std::unordered_set<std::uint64_t>& names, std::size_t first) {
                for (std::size_t index = 0; index < assets.size(); ++index) {
                    auto& asset = assets[index];
                    if (!names.contains(name_hash(asset.name))) continue;
                    const auto named = changes.find(lower(asset.name));
                    if (named == changes.end()) continue;
                    const auto change = named->second.find(asset.sha1);
                    const auto at = (casBacked ? 1 : 0) + first + index;
                    if (change == named->second.end() || change->second.mod == modName || at >= region.files.size())
                        continue;
                    const auto& resource = change->second.resource;
                    if (asset.kind == fb::AssetKind::resource &&
                        (!resource || resource->resourceType != asset.resourceType || resource->resourceId != asset.resourceId))
                        continue;
                    try {
                        overridden[at] = store.write(region.files[at].location.installChunk, manifestArchive,
                                                     change->second.encoded);
                        asset.sha1 = change->second.sha1;
                        asset.originalSize = change->second.originalSize;
                        if (resource) asset.resourceMeta = resource->resourceMeta;
                        wanted.insert(change->second.names.begin(), change->second.names.end());
                        if (example.empty()) example = asset.name + " from " + change->second.mod;
                    } catch (const std::exception& error) {
                        report.notes.push_back(modName + ": " + bundle.name + ": " + asset.name +
                            " kept the game's copy, the change could not be copied (" + error.what() + ")");
                    }
                }
            };
            replace(manifest.ebx, overrides.changed, changedNames, 0);
            replace(manifest.resources, overrides.scripts, scriptNames, manifest.ebx.size());
            if (casBacked) casManifest = std::move(manifest);
            else if (!overridden.empty()) region.inlineManifest = fb::write_binary_bundle(manifest);
            if (!overridden.empty())
                report.notes.push_back(modName + ": " + bundle.name + ": " + std::to_string(overridden.size()) +
                    " asset(s) take another mod's change, e.g. " + example);
        }
        // Assets another mod added to the game's copy of this bundle: this copy
        // loads instead of the game's on this mod's levels, so it gets them too.
        std::vector<Asset> additions;
        if (propagate && casBacked) {
            std::vector<const AssetAddition*> take;
            std::set<const AssetAddition*> taking;
            // A copy in the TOC the adder ships itself merges with the adder's bundle and has
            // its assets already; only copies in other superbundles (maps) need them carried.
            const auto here = lower(relative);
            if (const auto found = overrides.added.find(key); found != overrides.added.end())
                for (const auto& addition : found->second) {
                    if (addition.mod == modName || addition.asset.kind == fb::AssetKind::chunk ||
                        addition.toc == here) continue;
                    take.push_back(&addition);
                    taking.insert(&addition);
                }
            // What the changes this copy took name. The game keeps a list in more
            // bundles than the one a mod added to (the music playlist is in eight),
            // and a copy of any of them takes the changed list: it needs what the
            // mod added next to that list, and what those refer to in turn.
            for (std::vector<fb::Guid> open(wanted.begin(), wanted.end()); !open.empty();) {
                const auto guid = open.back();
                open.pop_back();
                const auto [first, last] = addedByGuid.equal_range(guid);
                for (auto at = first; at != last; ++at) {
                    const auto& [from, addition] = at->second;
                    if ((*from == key && addition->toc == here) || !taking.insert(addition).second) continue;
                    take.push_back(addition);
                    for (const auto& name : addition->names)
                        if (wanted.insert(name).second) open.push_back(name);
                    // The resource added under the same name goes where the asset goes.
                    if (const auto companion = companions.find({*from, addition->mod, lower(addition->asset.name)});
                        companion != companions.end() && taking.insert(companion->second).second)
                        take.push_back(companion->second);
                }
            }
            if (!take.empty()) {
                std::set<std::string, std::less<>> present;
                for (const auto& asset : casManifest.ebx) present.insert(asset_key(asset));
                for (const auto& asset : casManifest.resources) present.insert(asset_key(asset));
                const auto installChunk = region.files.front().location.installChunk;
                for (const auto* addition : take) {
                    if (!present.insert(asset_key(addition->asset)).second) continue;
                    try {
                        auto placed = carriedAt.find({installChunk, addition});
                        if (placed == carriedAt.end())
                            placed = carriedAt.emplace(std::pair{installChunk, addition},
                                store.carry(installChunk, manifestArchive, addition->encoded)).first;
                        additions.push_back({addition->asset, placed->second});
                        addedFrom.insert(addition->mod);
                    } catch (const std::exception& error) {
                        report.notes.push_back(modName + ": " + bundle.name + ": " + addition->asset.name +
                            " from " + addition->mod + " could not be added (" + error.what() + ")");
                    }
                }
                if (!additions.empty())
                    report.notes.push_back(modName + ": " + bundle.name + ": " + std::to_string(additions.size()) +
                        " asset(s) added by other mods, e.g. " + additions.front().asset.name);
            }
        }
        // Nothing moved in this bundle: it passes through whole, as before.
        if (casBacked && !shared && !gridBundle && renumbered.empty() && overridden.empty() && additions.empty())
            casBacked = false;

        for (auto& file : region.files) {
            store.shift(file.location, file.offset, placement);
            if (file.location.patch) used.emplace(file.location.installChunk, file.location.archive);
        }
        // Which of the region's files now lie in the merged patch rather than in this
        // mod's own archives, by position. Kept in step with region.files: an addition
        // below moves every later file along, and the pass over the bundle's assets
        // further down asks by where a file is then, not where it was.
        std::vector<bool> inPatch(region.files.size());
        for (const auto* moved : {&renumbered, &overridden})
            for (const auto& [index, file] : *moved) {
                region.files[index] = file;
                inPatch[index] = true;
                used.emplace(file.location.installChunk, file.location.archive);
            }
        // Added EBX go after this copy's own EBX and added resources after its own
        // resources, ahead of its chunks; after the indexed moves above so their
        // positions still hold.
        for (auto& addition : additions) {
            const auto ebx = addition.asset.kind == fb::AssetKind::ebx;
            const auto at = static_cast<std::ptrdiff_t>(1 + casManifest.ebx.size() + (ebx ? 0 : casManifest.resources.size()));
            (ebx ? casManifest.ebx : casManifest.resources).push_back(std::move(addition.asset));
            region.files.insert(region.files.begin() + at, addition.file);
            inPatch.insert(inPatch.begin() + at, true);
            used.emplace(addition.file.location.installChunk, addition.file.location.archive);
        }
        const auto fresh = !states.contains(key);
        if (fresh) { order.push_back(bundle.name); states.emplace(key, BundleState{}); }
        auto& state = states.at(key);

        if (region.inlineManifest.empty() && !casBacked) {
            // A copy whose contents cannot be read can only be passed through whole.
            // Once other providers have merged into this bundle, taking it whole
            // would throw their additions away (every map that shares the root
            // bundle would lose its level), so the unreadable copy is left out
            // instead: only its own additions to this bundle go missing.
            if (!fresh && !state.opaque && !isBase) {
                report.notes.push_back(modName + ": " + bundle.name +
                    ": left out of the merge, so this mod's additions to it are missing; "
                    "rebuild the mod with a current Studio");
                report.problems[modName].push_back(bundle.name + ": left out of the merge because " +
                    manifestFailure + "; this mod's additions to that bundle are missing");
                return;
            }
            if (fresh || !isBase) {
                // One unreadable copy replacing another: the earlier mod's
                // additions go with it.
                if (state.opaque && !state.opaqueBy.empty() && state.opaqueBy != modName)
                    report.problems[state.opaqueBy].push_back(bundle.name + ": replaced by " + modName +
                        "'s copy because " + state.opaqueWhy + "; this mod's additions to that bundle are missing");
                state.opaque = true;
                state.opaqueBy = isBase ? std::string{} : modName;
                state.opaqueWhy = manifestFailure;
                state.files = std::move(region.files);
                state.assets.clear(); state.seen.clear();
                state.metadata.clear(); state.shippedChunks.clear();
                state.gameMetadata = ChunkRecord::none;
            }
            return;
        }
        const auto manifest = casBacked ? casManifest : fb::read_binary_bundle(region.inlineManifest);
        auto flat = flatten(region, manifest, casBacked ? 1 : 0);
        if (state.opaque) {
            // A named copy is more useful than an opaque one, so it takes over.
            if (isBase) return;
            if (!state.opaqueBy.empty() && state.opaqueBy != modName)
                report.problems[state.opaqueBy].push_back(bundle.name + ": replaced by " + modName +
                    "'s readable copy because " + state.opaqueWhy +
                    "; this mod's additions to that bundle are missing");
            state.opaque = false;
            state.opaqueBy.clear();
            state.opaqueWhy.clear();
            state.files.clear();
        }
        if (casBacked) state.casBacked = true;
        if (!region.files.empty()) state.manifestChunk = region.files.front().location.installChunk;
        // Each chunk remembers where this copy lists it, and with that its record
        // in this copy's chunk metadata, whichever version of the chunk is kept.
        {
            auto copy = ChunkRecord::none;
            if (!manifest.chunkMetadata.empty()) {
                auto list = std::find(state.metadata.begin(), state.metadata.end(), manifest.chunkMetadata);
                if (list == state.metadata.end()) list = state.metadata.insert(state.metadata.end(), manifest.chunkMetadata);
                copy = static_cast<std::size_t>(list - state.metadata.begin());
            }
            if (isBase) {
                state.gameMetadata = copy;
                state.shippedChunks.clear();
                for (const auto& chunk : manifest.chunks) state.shippedChunks.push_back(chunk.guid);
            }
            const auto firstChunk = manifest.ebx.size() + manifest.resources.size();
            for (std::size_t index = 0; index < manifest.chunks.size() && firstChunk + index < flat.size(); ++index) {
                auto& record = flat[firstChunk + index].record;
                record.guid = manifest.chunks[index].guid;
                record.copy = copy;
                record.index = index;
                if (isBase) record.shipped = index;
            }
        }
        const std::size_t firstFile = casBacked ? 1 : 0;
        const auto* owner = isBase ? nullptr : &*owners.insert(modName).first;
        // By the mod whose added assets this copy's replace: how many, and one of them.
        std::map<std::string, std::pair<std::size_t, std::string>> replaced;
        for (std::size_t position = 0; position < flat.size(); ++position) {
            auto& entry = flat[position];
            entry.base = isBase;
            entry.mod = owner;
            auto id = asset_key(entry.asset);
            // A copy rewritten above (another mod's change, renumbered collision)
            // or added from another mod is not this mod's edit and does not lie in
            // this mod's archives: it is in the merged patch. Recorded as a
            // contribution it was read back from the mod's folder at the patch's
            // offset, the read failed, and the assets that really had two edits
            // (the item collections every cosmetic mod adds its items to) fell back
            // to one mod's copy.
            const bool rewritten = firstFile + position < inPatch.size() && inPatch[firstFile + position];
            // A mod's copy that is the game's adds nothing: the game's copy is recorded, first.
            const bool combinable = !rewritten && (entry.asset.kind == fb::AssetKind::ebx || entry.asset.kind == fb::AssetKind::resource);
            if (combinable && !isBase && state.matches_game_copy(id, entry.asset.sha1)) {
                ++report.unchangedCopies;
            } else if (combinable) {
                // The contributor's own copy still sits at its original offset in
                // its own folder, which is where a later merge reads it from.
                auto unshifted = entry.file;
                if (placement && unshifted.location.patch)
                    if (const auto* directory = store.find_directory(unshifted.location.installChunk))
                        unshift(*placement, *directory, unshifted.location.archive, unshifted.offset);
                state.history[id].push_back(
                    {&root, unshifted, entry.asset.sha1, entry.asset.resourceMeta, isBase});
            }
            if (isBase) state.baseSha.insert_or_assign(id, entry.asset.sha1);
            const auto at = state.seen.find(id);
            if (at == state.seen.end()) {
                state.seen.emplace(std::move(id), state.assets.size());
                state.assets.push_back(std::move(entry));
                continue;
            }
            // A mod replacing an asset the base also ships wins over the base,
            // and the highest-priority mod wins over the mods below it.
            if (!isBase) {
                // Map mods rebuild shared bundles wholesale, so they carry the
                // base's copy of every asset they did not touch. That copy must
                // never win over a mod that actually changed the asset -- on
                // priority alone, a map mod's untouched shader tables reverted
                // a costume mod's, and its clothing rendered wrong.
                const auto& previous = state.assets[at->second];
                if (const auto shipped = state.baseSha.find(at->first); shipped != state.baseSha.end() &&
                    entry.asset.sha1 == shipped->second && previous.asset.sha1 != shipped->second)
                    continue;
                // Two mods rewriting one non-EBX asset cannot both be honoured;
                // say so, because the loser silently loses whatever it shipped.
                if (entry.asset.kind == fb::AssetKind::chunk && !previous.base &&
                    previous.asset.sha1 != entry.asset.sha1)
                    report.notes.push_back("contested chunk " + entry.asset.name +
                        ": kept the highest-priority copy");
                // Two mods each adding a different asset under one name: a bundle
                // holds one asset per name, so the lower-priority mod's is gone,
                // and whatever of that mod's still names it by guid finds nothing
                // (an item list entry is dropped for that further down).
                if (entry.asset.kind != fb::AssetKind::chunk && !rewritten && previous.mod &&
                    previous.mod != owner && previous.asset.sha1 != entry.asset.sha1 &&
                    !state.baseSha.contains(at->first)) {
                    auto& [count, example] = replaced[*previous.mod];
                    if (!count++) example = entry.asset.name;
                    state.displaced.emplace_back(at->first, previous.asset.sha1);
                }
                // Whichever version is kept, it is still the chunk the game lists there.
                entry.record.shipped = previous.record.shipped;
                state.assets[at->second] = std::move(entry);
            }
        }
        for (const auto& [other, clash] : replaced)
            report.notes.push_back(other + ": " + bundle.name + ": " + std::to_string(clash.first) +
                " added asset(s) share a name with ones " + modName + " adds, e.g. " + clash.second +
                "; the merged bundle keeps " + modName + "'s");
    };

    if (base) for (const auto& bundle : base->bundles) absorb(bundle, nullptr, true, baseRoot);
    const auto baseBundles = order.size();
    // Lowest priority first, so the highest-priority mod overwrites the rest.
    for (auto source = sources.rbegin(); source != sources.rend(); ++source)
        for (const auto& bundle : source->toc.bundles)
            absorb(bundle, source->placement, false, source->root);

    for (const auto& name : order) {
        auto& state = states.at(lower(name));
        std::vector<std::byte> region;
        if (state.opaque) {
            region = fb::write_bundle_region(state.files, {});
        } else {
            // A placement that is not a patch one still lives in the
            // base install, whichever mod's copy referenced it.
            const auto decode = [&](const Contribution& from) {
                return fb::decode_cas(
                    store.read(from.file.location.patch ? *from.root : baseRoot,
                               from.file.location, from.file.offset, from.file.size),
                    {gameRoot});
            };
            HeldAssets held(state, decode);
            // Two mods rewriting one EBX asset is the case layering can never
            // answer: whichever copy wins, the other mod's additions are gone.
            // Combining the documents is the only shape that keeps both.
            for (auto& entry : state.assets) {
                const auto shaderTable = entry.asset.kind == fb::AssetKind::resource &&
                    (entry.asset.resourceType == fb::shader::programLookupType ||
                     entry.asset.resourceType == fb::shader::textureLookupType);
                // Cosmetic mods each register their presets in the character
                // bundle-reference table; the winning copy alone would leave the
                // other mods' items pointing at presets the game cannot find.
                const auto refTable = entry.asset.kind == fb::AssetKind::resource &&
                    fb::bundle_ref::is_table(entry.asset.name);
                if (entry.asset.kind != fb::AssetKind::ebx && !shaderTable && !refTable) continue;
                const auto found = state.history.find(asset_key(entry.asset));
                if (found == state.history.end()) continue;
                const Contribution* baseCopy{};
                for (const auto& contribution : found->second)
                    if (contribution.base) { baseCopy = &contribution; break; }
                if (!baseCopy) continue;
                // Both mods rebuild the whole bundle, so only the assets whose
                // content actually moved away from the base are contested.
                std::vector<const Contribution*> edits;
                for (const auto& contribution : found->second)
                    if (!contribution.base && contribution.sha1 != baseCopy->sha1)
                        edits.push_back(&contribution);
                // An item list is looked at even when one mod alone changed it:
                // what its entries name has to be in the bundle either way.
                const auto named = entry.asset.kind == fb::AssetKind::ebx && item_list_name(entry.asset.name);
                if (edits.size() < 2 && !(named && edits.size() == 1)) continue;
                try {
                    const auto baseBytes = decode(*baseCopy);
                    std::vector<std::vector<std::byte>> editBytes;
                    for (const auto* edit : edits) editBytes.push_back(decode(*edit));

                    std::vector<std::byte> rebuilt;
                    std::string what;
                    if (refTable) {
                        std::vector<fb::bundle_ref::Table> tables;
                        for (std::size_t index = 0; index < editBytes.size(); ++index)
                            tables.push_back({editBytes[index], edits[index]->resourceMeta});
                        const auto table = fb::bundle_ref::merge({baseBytes, baseCopy->resourceMeta}, tables);
                        if (!table.added) continue;
                        rebuilt = table.resource;
                        entry.asset.resourceMeta = table.resourceMeta;
                        what = std::to_string(table.added) + " preset(s)";
                        if (table.conflicts)
                            what += ", " + std::to_string(table.conflicts) + " disagreed";
                        // Mods number their presets alike, so two can share a leaf
                        // name the table has one row for. Both are registered; say
                        // whose name the other answers to, so an item that shows
                        // the wrong preset can be traced to its mod.
                        std::map<std::size_t, std::pair<std::size_t, std::string>> shadowed;
                        for (const auto& clash : table.shadowed) {
                            auto& [count, example] = shadowed[clash.edit];
                            if (!count++) example = clash.path + " and " + clash.holder;
                        }
                        for (const auto& [index, clash] : shadowed)
                            report.notes.push_back(path_utf8(edits[index]->root->filename()) + ": " +
                                std::to_string(clash.first) + " preset(s) share a short name with another mod's, e.g. " +
                                clash.second + "; they are registered by their full path only");
                    } else if (shaderTable) {
                        // Each mod aliases new material keys onto shader programs
                        // and texture sets the base already ships, so the union of
                        // the rows they added is exactly right.
                        std::vector<fb::shader::Table> tables;
                        for (std::size_t index = 0; index < editBytes.size(); ++index)
                            tables.push_back({editBytes[index], edits[index]->resourceMeta});
                        const fb::shader::Table baseTable{baseBytes, baseCopy->resourceMeta};
                        const auto table = entry.asset.resourceType == fb::shader::programLookupType
                            ? fb::shader::merge_program_lookup(baseTable, tables)
                            : fb::shader::merge_texture_lookup(baseTable, tables);
                        if (!table.added) continue;
                        rebuilt = table.resource;
                        entry.asset.resourceMeta = table.resourceMeta;
                        what = std::to_string(table.added) + " material row(s)";
                        if (table.conflicts)
                            what += ", " + std::to_string(table.conflicts) + " disagreed";
                    } else {
                        const auto baseDocument = fb::ebx::read_document(baseBytes);
                        const auto itemList = lower(baseDocument.rootType) == item_list_type;
                        if (edits.size() < 2 && !itemList) continue;
                        // A material grid is a square interaction matrix whose rows are
                        // addressed by slot numbers baked into each map's collision.
                        // Two mods that each appended surfaces both claim the same
                        // slots, so a plain merge would hand one map's triangles the
                        // other map's materials. The grid plan combines them instead
                        // and renumbers the collision (mod_merge_grid.cpp).
                        if (lower(baseDocument.rootType).find("materialgrid") != std::string::npos) {
                            if (grid.payload.empty())
                                report.notes.push_back(entry.asset.name + ": " + std::to_string(edits.size()) +
                                    " mods edit the shared material grid; kept the highest-priority copy");
                            continue;
                        }
                        std::vector<fb::ebx::Document> editDocuments;
                        for (const auto& bytes : editBytes)
                            editDocuments.push_back(fb::ebx::read_document(bytes));
                        std::vector<const fb::ebx::Document*> pointers;
                        for (const auto& document : editDocuments) pointers.push_back(&document);
                        // An item a mod lists is an asset that mod adds to this bundle.
                        // When it is not here (another mod added a different asset
                        // under its name, or the mod was built on top of a mod that
                        // is not installed) the entry goes: the mod loses that item,
                        // which it had already lost, and the game still starts.
                        const fb::ebx::CarryImport inBundle = [&](const fb::ebx::ImportReference& item) {
                            // What the game's own list names is the game's to answer for.
                            return std::ranges::any_of(baseDocument.imports, [&](const fb::ebx::ImportReference& known) {
                                       return known.fileGuid == item.fileGuid; }) ||
                                   held.holds(item.fileGuid);
                        };
                        // Any other list loses an entry only when what it names was in
                        // this bundle and another mod's asset of the same name took its
                        // place: nothing else is known about where its entries live.
                        const fb::ebx::CarryImport notReplaced = [&](const fb::ebx::ImportReference& named) {
                            return !held.replacement(named.fileGuid) || held.holds(named.fileGuid);
                        };
                        fb::ebx::MergeSummary summary;
                        auto combined = fb::ebx::merge_documents(baseDocument, pointers, &summary,
                                                                 itemList ? inBundle : notReplaced);
                        const auto mod_of = [&](std::size_t edit) { return path_utf8(edits[edit]->root->filename()); };
                        if (summary.dropped.empty() && !summary.instances && !summary.arrayEntries) {
                            // One mod's copy with nothing to leave out stays as that mod wrote it.
                            if (edits.size() < 2) continue;
                            // The same change from each of them is one change.
                            if (std::ranges::all_of(edits, [&](const Contribution* edit) {
                                    return edit->sha1 == edits.front()->sha1; })) continue;
                            // Nothing was added to it, so each mod changed what was there.
                            // Values changed in place combine; when that is not all of
                            // some mod's change, the copy already kept stays whole, and
                            // the others' changes to it are not in the game.
                            if (!summary.values || !summary.exact()) {
                                std::set<std::string> others;
                                for (std::size_t index = 0; index < edits.size(); ++index)
                                    if (edits[index]->sha1 != entry.asset.sha1) others.insert(mod_of(index));
                                if (entry.mod) others.erase(*entry.mod);
                                std::string names;
                                for (const auto& other : others) names += (names.empty() ? "" : ", ") + other;
                                if (!others.empty())
                                    report.notes.push_back(entry.asset.name + ": kept " +
                                        (entry.mod ? *entry.mod + "'s copy" : std::string("the highest-priority copy")) +
                                        " whole; the changes " + names + " made to it are of a kind that cannot be "
                                        "combined with it and are not in the game");
                                continue;
                            }
                        }
                        rebuilt = fb::ebx::write_document(combined);
                        what = std::to_string(summary.instances) + " instance(s), " +
                               std::to_string(summary.arrayEntries) + " list entries";
                        if (summary.values) what += ", " + std::to_string(summary.values) + " changed value(s)";
                        if (summary.contested) what += ", " + std::to_string(summary.contested) + " disagreed";
                        if (summary.repeated)
                            what += ", " + std::to_string(summary.repeated) + " repeated entry(ies) listed once";
                        // The merged copy is the game's with what the mods added: a mod's
                        // change to what was already there is in it only when it is one
                        // that could be taken.
                        for (const auto index : summary.uncarried)
                            report.notes.push_back(mod_of(index) + ": " + entry.asset.name +
                                ": the merged copy has what this mod added to it, but not its changes to what "
                                "the game's copy already held");
                        std::map<std::size_t, std::vector<fb::Guid>> left;   // by edit
                        for (const auto& gone : summary.dropped) left[gone.edit].push_back(gone.target.fileGuid);
                        for (const auto& [index, guids] : left) {
                            // Name the mod whose asset took the item's name, when that is why.
                            const Asset* taken{};
                            for (const auto& guid : guids) {
                                taken = held.replacement(guid);
                                if (taken) break;
                            }
                            report.notes.push_back(mod_of(index) + ": " + entry.asset.name +
                                ": " + std::to_string(guids.size()) + (itemList ? " item(s)" : " entry(ies)") +
                                " left out of the list because the merged "
                                "bundle does not hold them, e.g. " +
                                (taken ? taken->asset.name + ", replaced by " + (taken->mod ? *taken->mod : "another mod") +
                                             "'s asset of the same name"
                                       : "the asset with guid " + guids.front().string() +
                                             ", which no enabled mod adds to the bundle"));
                        }
                    }
                    const auto placement = store.write(state.manifestChunk, manifestArchive,
                                                       fb::encode_cas(rebuilt, {gameRoot}));
                    entry.file = placement;
                    entry.asset.sha1 = sha1_of(rebuilt);
                    entry.asset.originalSize = rebuilt.size();
                    used.emplace(placement.location.installChunk, placement.location.archive);
                    if (edits.size() < 2) continue;
                    report.notes.push_back(entry.asset.name + ": combined " +
                        std::to_string(edits.size()) + " edits (" + what + ")");
                    ++report.mergedAssets;
                } catch (const std::exception& failure) {
                    report.notes.push_back(entry.asset.name +
                        ": kept the highest-priority copy, the edits could not be combined (" +
                        failure.what() + ")");
                }
            }

            if (!grid.payload.empty() && lower(name) == grid.bundle) {
                const auto found = state.seen.find(std::to_string(static_cast<int>(fb::AssetKind::ebx)) + ':' + grid.asset);
                if (found == state.seen.end()) {
                    report.notes.push_back("material grid: " + grid.asset + " is not in " + name +
                        "; the combined grid was not published");
                } else {
                    auto& entry = state.assets[found->second];
                    entry.file = store.write(state.manifestChunk, manifestArchive,
                                             fb::encode_cas(grid.payload, {gameRoot}));
                    entry.asset.sha1 = sha1_of(grid.payload);
                    entry.asset.originalSize = grid.payload.size();
                    used.emplace(entry.file.location.installChunk, entry.file.location.archive);
                    ++report.mergedAssets;
                }
            }

            // The merged bundle holds every mod's chunks, so its chunk metadata has
            // to describe them all, and in the game's own form: a record for each
            // chunk, in the order of the chunks' guids. With the game's list alone,
            // or with the lists the mods ship (which are not in that order, and
            // have lost the records their tools wrote over), the meshes and textures
            // of costumes built on one game costume never stream in.
            std::vector<std::byte> metadata;
            {
                std::vector<ChunkRecord> records;
                std::size_t fromMods{};
                for (const auto& entry : state.assets) {
                    if (entry.asset.kind != fb::AssetKind::chunk) continue;
                    records.push_back(entry.record);
                    fromMods += entry.record.shipped == ChunkRecord::none || entry.record.copy != state.gameMetadata;
                }
                try {
                    metadata = merge_chunk_metadata(state.metadata, records, state.gameMetadata, state.shippedChunks);
                    if (fromMods && state.gameMetadata != ChunkRecord::none &&
                        metadata != state.metadata[state.gameMetadata])
                        report.notes.push_back(name + ": chunk metadata written again for " + std::to_string(records.size()) +
                            " chunks, " + std::to_string(fromMods) + " of them added, changed or carried by mods");
                } catch (const std::exception& failure) {
                    if (!state.metadata.empty()) metadata = state.metadata.front();
                    report.notes.push_back(name + ": the copies' chunk metadata could not be put together (" + failure.what() +
                        "); kept the first copy's, so chunks mods add to this bundle may not load");
                }
            }
            fb::BinaryBundle manifest;
            std::vector<fb::BundleFileInfo> files;
            build_manifest(state.assets, metadata, manifest, files);
            if (!state.casBacked) {
                region = fb::write_bundle_region(files, fb::write_binary_bundle(manifest));
            } else {
                // The merged manifest goes back into the patch's own archive,
                // stored raw like the ones it replaces, and becomes the region's
                // first placement again.
                const auto placement = store.write(state.manifestChunk, manifestArchive,
                                                   fb::write_binary_bundle(manifest));
                used.emplace(placement.location.installChunk, placement.location.archive);
                files.insert(files.begin(), placement);
                region = fb::write_bundle_region(files, {});
                ++report.mergedBundles;
            }
        }
        merged.bundles.push_back({name, std::move(region), 1});
    }

    std::map<fb::Guid, std::size_t> chunkAt;
    // A chunk entry identical to the base's is a mod carrying it unchanged.
    std::map<fb::Guid, fb::TocChunk> baseChunk;
    if (base) for (const auto& chunk : base->chunks) {
        baseChunk.emplace(chunk.guid, chunk);
        if (chunkAt.emplace(chunk.guid, merged.chunks.size()).second) merged.chunks.push_back(chunk);
    }
    const auto same = [](const fb::TocChunk& left, const fb::TocChunk& right) {
        return left.location == right.location && left.offset == right.offset &&
               left.size == right.size && left.removed == right.removed;
    };
    for (auto source = sources.rbegin(); source != sources.rend(); ++source) {
        for (auto chunk : source->toc.chunks) {
            store.shift(chunk.location, chunk.offset, source->placement);
            if (chunk.location.patch && !chunk.removed)
                used.emplace(chunk.location.installChunk, chunk.location.archive);
            const auto at = chunkAt.find(chunk.guid);
            if (at != chunkAt.end()) {
                const auto shipped = baseChunk.find(chunk.guid);
                const auto carried = shipped != baseChunk.end() && same(chunk, shipped->second);
                const auto changed = shipped != baseChunk.end() && !same(merged.chunks[at->second], shipped->second);
                if (!(carried && changed)) merged.chunks[at->second] = chunk;
                continue;
            }
            chunkAt.emplace(chunk.guid, merged.chunks.size());
            merged.chunks.push_back(chunk);
        }
    }
    // This superbundle resolves chunks from its own TOC: the audio of a song another
    // mod added to a bundle copied here has to be listed here as well.
    for (const auto& name : addedFrom) {
        const auto found = overrides.chunks.find(name);
        if (found == overrides.chunks.end()) continue;
        std::size_t listed{};
        for (const auto& chunk : found->second) {
            if (!chunkAt.emplace(chunk.guid, merged.chunks.size()).second) continue;
            merged.chunks.push_back(chunk);
            used.emplace(chunk.location.installChunk, chunk.location.archive);
            ++listed;
        }
        if (listed) report.notes.push_back(relative + ": " + std::to_string(listed) + " chunk(s) from " + name);
    }

    if (sources.size() > 1) {
        report.notes.push_back(relative + ": combined " + std::to_string(sources.size()) +
            " mods over " + std::to_string(baseBundles) + " base bundle(s)");
    }
    for (const auto& [modName, fault] : archiveFaults) {
        std::string text = relative + ": " + std::to_string(fault.bundles) + " bundle(s) point outside the "
            "archives this mod ships (" + std::to_string(fault.missing) + " file(s) in archives that are not "
            "there, " + std::to_string(fault.overrun) + " past the end of one); e.g. " + fault.example +
            ". The mod folder is incomplete or from a different build: reinstall it whole";
        report.notes.push_back(modName + ": " + text);
        report.problems[modName].push_back(std::move(text));
    }
    return merged;
}

} // namespace dingosdk::mods::detail