From 329da4bfce39513a27a783cc322ff236df03030a Mon Sep 17 00:00:00 2001 From: CrazyRedMachine <36906596+CrazyRedMachine@users.noreply.github.com> Date: Sun, 5 May 2024 19:54:08 +0200 Subject: [PATCH] Add fix_backgrounds.py --- omnimix/README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/omnimix/README.md b/omnimix/README.md index df1f904..d5ae5fa 100644 --- a/omnimix/README.md +++ b/omnimix/README.md @@ -4,6 +4,21 @@ Refer to [omnimix_db.md](omnimix_db.md) # Omnimix tools +## fix_backgrounds.py + +Fixes musicdb xmls for correct background display in unilab+. + +(Unilab has changed the mask bitfield to add a "force load background" entry. This script will check all songs with a bg_xxxx.ifs file and update the xmls accordingly) + +Usage: +1. Copy fix_backgrounds.py in data_mods folder +2. Run the script +3. Verify the backgrounds are working as expected + +**Note**: All modified XMLs are first copied to `data_mods\_fix_backgrounds_backup`. If you encounter any issue, copy this folder contents back into data_mods and overwrite when prompted. + +This will restore the initial state. + ## ida_find_addrs.py IDA script tested in 6.6 and 7.x. @@ -73,4 +88,4 @@ Example: `python3 verify_data.py --input-dll popn22.dll --input-xml db/patches_2 - ~~As of time of writing, the latest version of ifstools (1.14) will not extract jacket.ifs properly on Windows due to NTFS's case-insensitivity, resulting in 3 images being overwritten with data that won't work in-game. You can extract on a *nix system to get the correct jacket images if you see a green block in place of the jackets for the affected songs.~~ - Not pushed out to pypi yet, but this has already been fixed in master and will be included in the next release of ifstools where you can use the `--rename-dupes` flag (thanks mon!). -- Character database editing is slightly restrictive at the moment due to not being able to add new entries to the flavor table. When trying to add new entries to the flavor table there is a high chance of the game crashing in my experience. My guess is that there are some more places that should be patched that I have not found yet. This is a technical issue that could be solved with more work but it's more of a stretch goal than a main goal for this project so I put in a bandaid to make sure that the flavor table never expands. This issue is also why some unlocked characters will turn into Nyami alts. \ No newline at end of file +- Character database editing is slightly restrictive at the moment due to not being able to add new entries to the flavor table. When trying to add new entries to the flavor table there is a high chance of the game crashing in my experience. My guess is that there are some more places that should be patched that I have not found yet. This is a technical issue that could be solved with more work but it's more of a stretch goal than a main goal for this project so I put in a bandaid to make sure that the flavor table never expands. This issue is also why some unlocked characters will turn into Nyami alts.