Generate Update

With the launcher you can fully update the game with console connected to the internet. Here is how you can generate an update.

---

Creating Update Patches

Use the PatchGenerator tool (Windows) to create update patches. It uses xdelta3 compression to generate small patch files.

Automated Build Script:

The included run.bat script automates the entire update creation process.

Setup paths.txt with your source and destination folders paths:

Line 1: Source files path (previous version)
Line 2: Modified files path (new version)
Line 3: Output path (auto-filled by script)
Line 4: Extracted Brawl ISO path - Used for file comparison when creating patches
Line 5: Server URL for downloads

Run run.bat - it will:

• Execute Patcher.exe to generate xdelta3 patches
• Prompt for build abbreviation (e.g., pm, te, xp)
• Prompt for base version (e.g., 1.0)
• Prompt for new version (e.g., 1.1)
• Create a 7z archive: {abbr}update-{base}-{patch}.7z
• Calculate file size and MD5 checksum
• Generate update.xml with all values filled in
• Open update.xml in notepad for review

Requirements:

• 7-Zip must be installed (script will prompt to download if missing)
• Windows OS
• Extracted Brawl ISO folder (for file comparison)

Manual Usage: If you prefer manual control, run Patcher.exe paths.txt directly, then manually create the 7z archive and update.xml.

Update XML Structure

The script generates update.xml automatically. Here's the structure:

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <news>Your news here.</news>
    
    <launcher>
        <update updateVersion="1.1" length="1234567" md5="abcdef1234567890abcdef1234567890">
            <baseVersionsSupported>
                <baseVersion>1.0</baseVersion>
            </baseVersionsSupported>
            <url>https://yourserver.com/launcher-1.1.7z</url>
        </update>
    </launcher>
    
    <game>
        <update updateVersion="1.1" length="9876543" md5="0123456789abcdef0123456789abcdef">
            <baseVersionsSupported>
                <baseVersion>1.0</baseVersion>
            </baseVersionsSupported>
            <url>https://yourserver.com/pmupdate-1.0-1.1.7z</url>
        </update>
    </game>
</root>

• news: Scrolling ticker on main menu
• updateVersion: Target version
• length: File size in bytes (auto-calculated by script)
• md5: 32-character MD5 hash (auto-calculated by script)
• baseVersion: Version this update applies from (use * for any)
• url: Download link (auto-generated by script)

Offline Updates

For offline distribution, place .7z files in yourmod/launcher/updates/:

• Launcher: launcher-{version}.7z
• Game: pmupdate-{from}-{to}.7z

These are checked before online updates.