Add aoc directory support to botw-patcher #1
Conversation
botwfstools/botw_patcher.py
Outdated
| @@ -230,8 +237,16 @@ def cli_main() -> None: | |||
| parser.add_argument('target_dir', type=Path, help='Path to the target directory') | |||
| parser.add_argument('-f', '--force', action='store_true', help='Clean up the target directory if it exists') | |||
| parser.add_argument('-t', '--target', choices=['wiiu', 'switch'], help='Target platform', required=True) | |||
| subparsers = parser.add_subparsers() | |||
|
|
|||
| aoc_parser = subparsers.add_parser('aoc', help='Use a separate add-on-content directory as well') | |||
There was a problem hiding this comment.
Hmm, using a subparser sounds like a hack :p (it's intended to be used for subcommands, like sarc {create,update} for example, not optional arguments)
Could you replace this with --aoc-dir + --aoc-patch-dir + --aoc-target-dir? Having 6 positional arguments, separated with only aoc would also make commands too hard to read IMO.
botwfstools/botw_patcher.py
Outdated
| make_loadable_layer(args.content_dir, args.patch_dir, args.target_dir, | ||
| wiiu=(args.target == 'wiiu')) | ||
|
|
||
| wiiu=(args.target == 'wiiu') |
botwfstools/botw_patcher.py
Outdated
| table = rstb.util.read_rstb(args.content_dir / _RSTB_PATH_IN_CONTENT, be=wiiu) | ||
|
|
||
| make_loadable_layer(args.content_dir, args.patch_dir, args.target_dir, wiiu, table, is_aoc=False) | ||
| try: |
There was a problem hiding this comment.
After removing the subparser thing, exception handling can be replaced with a simpler, less surprising if check.
botwfstools/botw_patcher.py
Outdated
|
|
||
| ARCHIVE_EXTS = {'sarc', 'pack', 'bactorpack', 'bmodelsh', 'beventpack', 'stera', 'stats', | ||
| 'ssarc', 'spack', 'sbactorpack', 'sbmodelsh', 'sbeventpack', 'sstera', 'sstats', | ||
| 'blarc', 'sblarc', 'genvb', 'sgenvb'} | ||
| AOC_PREFIX = 'Aoc/0010/' | ||
| AOC_PREFIX_CONDITIONS = {'Terrain\/A\/AocField.*', 'Pack\/.*.pack', 'UI\/StaffRollDLC\/.*', |
There was a problem hiding this comment.
This should be a tuple or a list; it should not be a set.
Also, the list of conditions is technically not entirely correct. This will match all dungeon resources and all voice streams for example. The dungeon number needs to be checked like how Nintendo does it. Here is a fairly accurate re-implementation of the logic.
(Using regexes for that many strings is also going to be pretty expensive when you have many resources to patch. Best to use simple string comparisons for most cases and save regex/more complex parsing for the special cases)
botwfstools/botw_patcher.py
Outdated
|
|
||
| # File is not in any archive, so just return the path relative to the content root. | ||
| return rel_path.as_posix() | ||
| resource_path = rel_path.as_posix() |
There was a problem hiding this comment.
Since you've removed the return, the execution will always reach this line, meaning the correct value of resource_path for archived files will always be overwritten.
I suggest keeping the returns and just adding get_path() around the returned strings, where get_path is a local function that checks for is_aoc and the AoC conditions (see an earlier comment) and adds the prefix if needed. (Feel free to change the name to something better)
botwfstools/botw_patcher.py
Outdated
| 'Physics\/StaticCompound\/CDungeon\/.*', 'Movie\/Demo/.*', 'Game\/AocField\/.*', 'NavMesh\/AocField\/.*', | ||
| 'NavMesh\/MainFieldDungeon\/.*', 'NavMesh\/CDungeon\/.*', 'Physics\/TeraMeshRigidBody\/AocField\/.*', | ||
| 'Voice\/.*\/Stream_Demo\/.*\/.*\.bfstm', 'System\/AocVersion\.txt'} | ||
| RE_PATTERNS = {re.compile(string) for string in AOC_PREFIX_CONDITIONS} |
There was a problem hiding this comment.
This doesn't have to be a set either. A set is a specific data structure you use when you need fast inserts, removals or "is element in the set" checks. You're just iterating over the compiled regexp objects so a simple list is the best structure.
|
The issues raised should now be fixed. |
botwfstools/botw_patcher.py
Outdated
| if AOC_VOICE_PATTERN.match(new_path): | ||
| return AOC_PREFIX + new_path | ||
|
|
||
| dungeon_num_str = re.search('"Dungeon\((.+?)\)', new_path) |
There was a problem hiding this comment.
typo (there's an extra quote)
When running botw-patcher, you can now specify an aoc directory too:
It automatically handles the conditions for adding the 'Aoc/0010/' prefix, and saves the RSTB for both the content and aoc directories file correctly, into the non-aoc TARGET_DIR.