gazzamc / starfield_hex_updater

A script to patch SFSE (Starfield Script Extender) to work with gamepass / windows store version of Starfield

Starfield Hex Updater

Install/build instructions can be found HERE, you have the option of a powershell Auto Installer script or you can do the process manually.

Compatible/Incompatible mods can be found Here.

Requirements

I've tried to keep it as simple as possible, I've used only built-in imports. Using the below version of python, I'm sure any version above python 3.x would work, but if you have any trouble use the one I mentioned.

Be vigilant of the hex table name hex_table_{game_version}_{commit_id}.json, it consists of important data, so if you're having issues after running the update be sure you're trying to update with the correct hex table.

Python 3.11

Notes

• As of v0.1.3 the script can patch without providing the path, if placed in the root of the SFSE repo folder.

• Added a script to auto generate the hex table using the Address Libraries

• Added support for Powershell 7

Usage

    hex_script.py -m <mode> <options>

    Modes:
        generate: Creates a hex table for updating hex values
        update: Updates hex values using a hex dictionary
        patch: Patches out the error message preventing program from running

    <Options>
        -h, --help
        -m, --mode: Selects the mode to use
        -v, --version: script version number
            generate:
                -p, --path: Path of the old hex values, will be used as a reference (use full path)
                -n, --path2: Path of the new hex values, will become the value of the old key (use full path)
                -g, --starfield: Starfield game version, will be used in the filename
                -c, --commit: commit ID of a mod tool not to be named :?, will be used in the filename
                -s, --silent: hides any caught exceptions [Optional]
            update:
                -p, --path: Path to the folder of files to be updated, files will be backed up by default (use full path)
                -d, --dictfile: dictionary to be used for updating hex values (use full path)
                -b, --backup: Option to prevent backup files [Optional]
            patch:
                -p, --path: Path to the folder of files to be patched, files will be backed up by default (use full path) [Optional]
                -b, --backup: Option to prevent backup files [Optional]