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.

For updates/general support join the Discord Server.

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

Patcher

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

• As of v0.2.0, the script can now verify the files patched via md5 checksums

CLI

• Added support for Powershell 7

• As of v1.5.6, the powershell CLI can now install a standalone python version, this can be helpful if you're having issues detecting your install.

• As of v1.5.10, when setting the newGamePath, the permissions will be checked to ensure there's less issues when moving the Starfield executable.

Misc

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

Usage

    hex_updater.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
        md5: Will generate a md5 checksum for the files to verify patch was successful

    <Options>
        -h, --help
        -m, --mode: Selects the mode to use
        -v, --version: script version number
        -s, --silent: hides output of commands
            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: Truncated commit ID of SFSE, will be used in the filename
            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 backup files
            patch:
                -p, --path: Path to the folder of files to be patched, files will be backed up by default (use full path)
                -b, --backup: Option to backup files
            md5:
                -p, --path: Path to the folder containing the files
                -f, --filename: Filename of the file generated
                --verify: Verify patch/update via md5 hash

starfield_hex_updater's Issues

Request: Starfield Hard Link for Game Pass Mod

Create mod for the hardlink process.

Non-Compatible Mod (Add to the non compat mod list pls)

Mod Name: Detailed Reference Info
Nexus: https://www.nexusmods.com/starfield/mods/7589
Issue: Causes CTD after about 5 to 10 seconds after loading game.

Hex_table of version 1.7.36

How can I generate the json hex_table to a new version of the game every time it's release?

Create a Community Discord Server?

i was wondering if i could create a community discord server centered around this project (mainly so that i can keep up to date with starfield updates and this) and so that other xbox pc app users can get support in a "User Friendly" way, so is it alright if i could create a community discord, (i also wouldve dmd you else where but i dont have linked in or saw an email or other socials anywhere)

Script completely broken

When I try to launch run.bat it opens a new Powershell window, only to close it almost instantly. Also, when I try to launch it manually by opening cli.ps1 by hand, it either throws errors at me and go back to the main menu, either some terms aren't recognized as a name of cmdlet, function, script file, or executable program

Better Guide W/ Pictures

Hi can you create a guide with pictures, i keep screwing up somewhere and i cannot figure out how to fix up my screwup via text, as im not that great at text instructions

thanks

Add support for 1.9.51.0

Updated 2 days ago, patiently waiting for an update to this thanks

File placement

Im confused on where all these files go SFSE, hex_updated? Can you be a little bit more specific on where we place these files with git clone?

Request: SFSE for Game Pass Mod

Is there way we can package this up as SFSE for Game Pass mod so we only have to install pre-compiled files. Then make the mod outlined in #6 a requirement for this mod?

Update for 1.8.86

New Release https://bethesda.net/en/game/starfield/article/3V830KanHH0I2zTIKraEih/starfield-update-1-8-86-notes-november-20-2023
Expect SFSE to update as well.
May need updated hex tool

Still receiving "MS Gamepass Version" error when running sfse_loader after patching

I left this in a Reddit comment awhile ago as well.

After downloading a fresh SFSE install, patching, building and hardlinking I still receive the "You have the MS Store/Gamepass version of Starfield, which is not compatible with SFSE." error when launching sfse_loader.exe.

It's worth noting that when running the powershell script I receive an error about being unable to copy Starfield.exe and the need to manually copy it but I don't think that's the issue because it does copy Starfield.exe into the copy folder. And sfse_loader.exe doesn't throw the "I can't find starfield.exe" error. Nonetheless the original install path for me is G:/Games/Starfield/Content/starfield.exe and my copy folder is G:\Games\

StarfieldCopy\starfield.exe. Starfield.exe is successfully copied to the G:\Games\StarfieldCopy folder after running the script.

I've attached my log files for reference:
logfile_2024.05.23_09.04.15.log

And here's a screenshot of my StarfieldCopy folder