def export(output: Path): print("Loading files...") tmp_dir = Path(mkdtemp()) if tmp_dir.drive != util.get_modpack_dir().drive: tmp_dir = Path(util.get_modpack_dir().drive) / "tmp_bcml_export" if tmp_dir.exists(): try: rmtree(tmp_dir) except (OSError, FileNotFoundError, PermissionError) as err: raise RuntimeError( "There was a problem cleaning the temporary export directory. This may be" " a fluke, so consider restarting BCML and trying again." ) from err link_master_mod(tmp_dir) print("Adding rules.txt...") rules_path = tmp_dir / "rules.txt" mods = util.get_installed_mods() if util.get_settings("wiiu"): rules_path.write_text( "[Definition]\n" "titleIds = 00050000101C9300,00050000101C9400,00050000101C9500\n" "name = Exported BCML Mod\n" "path = The Legend of Zelda: Breath of the Wild/Mods/Exported BCML\n" f'description = Exported merge of {", ".join([mod.name for mod in mods])}\n' "version = 4\n", encoding="utf-8", ) if output.suffix == ".bnp" or output.name.endswith(".bnp.7z"): print("Exporting BNP...") dev.create_bnp_mod( mod=tmp_dir, meta={}, output=output, options={"rstb": { "no_guess": util.get_settings("no_guess") }}, ) else: print("Exporting as graphic pack mod...") x_args = [ZPATH, "a", str(output), f'{str(tmp_dir / "*")}'] result: subprocess.CompletedProcess if os.name == "nt": result = subprocess.run( x_args, creationflags=util.CREATE_NO_WINDOW, check=False, capture_output=True, ) else: result = subprocess.run(check=False, capture_output=True) if result.stderr: raise RuntimeError( f"There was an error exporting your mod(s). {result.stderr}") rmtree(tmp_dir, True)
def restore_backup(backup: Union[str, Path]): if isinstance(backup, str): backup = Path(backup) if not backup.exists(): raise FileNotFoundError(f'The backup "{backup.name}" does not exist.') print("Clearing installed mods...") for folder in [ item for item in util.get_modpack_dir().glob("*") if item.is_dir() ]: shutil.rmtree(str(folder)) print("Extracting backup...") x_args = [ get_7z_path(), "x", str(backup), f"-o{str(util.get_modpack_dir())}" ] if system() == "Windows": subprocess.run( x_args, stdout=subprocess.PIPE, stderr=subprocess.PIPE, creationflags=util.CREATE_NO_WINDOW, check=True, ) else: subprocess.run(x_args, stdout=subprocess.PIPE, stderr=subprocess.PIPE, check=True) print("Re-enabling mods in Cemu...") refresh_master_export() print(f'Backup "{backup.name}" restored')
def create_backup(name: str = ""): if not name: name = f'BCML_Backup_{datetime.datetime.now().strftime("%Y-%m-%d")}' else: name = re.sub(r"(?u)[^-\w.]", "", name.strip().replace(" ", "_")) num_mods = len([d for d in util.get_modpack_dir().glob("*") if d.is_dir()]) output = util.get_storage_dir() / "backups" / f"{name}---{num_mods - 1}.7z" output.parent.mkdir(parents=True, exist_ok=True) print(f"Saving backup {name}...") x_args = [ get_7z_path(), "a", str(output), f'{str(util.get_modpack_dir() / "*")}' ] if system() == "Windows": subprocess.run( x_args, stdout=subprocess.PIPE, stderr=subprocess.PIPE, creationflags=util.CREATE_NO_WINDOW, check=True, ) else: subprocess.run(x_args, stdout=subprocess.PIPE, stderr=subprocess.PIPE, check=True) print(f'Backup "{name}" created')
def uninstall_all(self): for folder in {d for d in util.get_modpack_dir().glob("*") if d.is_dir()}: rmtree(folder, onerror=install.force_del) if not util.get_settings("no_cemu"): shutil.rmtree( util.get_cemu_dir() / "graphicPacks" / "bcmlPatches", ignore_errors=True )
def restore_backup(backup: Union[str, Path]): """ Restores a BCML mod configuration backup :param backup: The backup to restore, either by name or by path :type backup: Union[str, Path] """ if isinstance(backup, str): backup = util.get_cemu_dir() / 'bcml_backups' / f'{backup}.7z' if not backup.exists(): raise FileNotFoundError(f'The backup "{backup.name}" does not exist.') print('Clearing installed mods...') for folder in [ item for item in util.get_modpack_dir().glob('*') if item.is_dir() ]: shutil.rmtree(str(folder)) print('Extracting backup...') x_args = [ str(util.get_exec_dir() / 'helpers' / '7z.exe'), 'x', str(backup), f'-o{str(util.get_modpack_dir())}' ] subprocess.run(x_args, stdout=subprocess.PIPE, stderr=subprocess.PIPE, creationflags=util.CREATE_NO_WINDOW) print('Re-enabling mods in Cemu...') refresh_cemu_mods() print(f'Backup "{backup.name}" restored')
def link_master_mod(output: Path = None): util.create_bcml_graphicpack_if_needed() if not output: if not util.get_settings("export_dir"): return output = Path(util.get_settings("export_dir")) if output.exists(): shutil.rmtree(output, ignore_errors=True) try: output.mkdir(parents=True, exist_ok=True) if not util.get_settings("no_cemu"): output.mkdir(parents=True, exist_ok=True) shutil.copy(util.get_master_modpack_dir() / "rules.txt", output / "rules.txt") except (OSError, PermissionError, FileExistsError, FileNotFoundError) as err: raise RuntimeError( "There was a problem creating the master BCML graphic pack. " "It may be a one time fluke, so try remerging and/or restarting BCML. " "This can also happen if BCML and/or Cemu are installed into Program " "Files or any folder which requires administrator (or root) permissions. " "You can try running BCML as administrator or root, but bear in mind this " "is not officially supported. If the problem persists, good luck, because " "it's something wonky about your PC, I guess.") from err mod_folders: List[Path] = sorted( [ item for item in util.get_modpack_dir().glob("*") if item.is_dir() and not (item / ".disabled").exists() ], reverse=True, ) util.vprint(mod_folders) link_or_copy: Any = os.link if not util.get_settings( "no_hardlinks") else copyfile for mod_folder in mod_folders: for item in mod_folder.rglob("**/*"): rel_path = item.relative_to(mod_folder) exists = (output / rel_path).exists() is_log = str(rel_path).startswith("logs") is_opt = str(rel_path).startswith("options") is_meta = str(rel_path).startswith("meta") is_extra = (len(rel_path.parts) == 1 and rel_path.suffix != ".txt" and not item.is_dir()) if exists or is_log or is_extra or is_meta or is_opt: continue if item.is_dir(): (output / rel_path).mkdir(parents=True, exist_ok=True) elif item.is_file(): try: link_or_copy(str(item), str(output / rel_path)) except OSError: if link_or_copy is os.link: link_or_copy = copyfile link_or_copy(str(item), str(output / rel_path)) else: raise
def link_master_mod(output: Path = None): util.create_bcml_graphicpack_if_needed() if not output: if util.get_settings("no_cemu"): return output = util.get_cemu_dir() / "graphicPacks" / "BreathOfTheWild_BCML" if output.exists(): shutil.rmtree(output, ignore_errors=True) try: output.mkdir(parents=True, exist_ok=True) if not util.get_settings("no_cemu"): shutil.copy(util.get_master_modpack_dir() / "rules.txt", output / "rules.txt") except (OSError, PermissionError, FileExistsError, FileNotFoundError) as err: raise RuntimeError( "There was a problem creating the master BCML graphic pack. " "It may be a one time fluke, so try remerging and/or restarting BCML. " "If the problem persists, good luck, because it's something wonky about your " "PC, I guess.") from err mod_folders: List[Path] = sorted( [ item for item in util.get_modpack_dir().glob("*") if item.is_dir() and not (item / ".disabled").exists() ], reverse=True, ) util.vprint(mod_folders) link_or_copy = os.link if not util.get_settings( "no_hardlinks") else copyfile for mod_folder in mod_folders: for item in mod_folder.rglob("**/*"): rel_path = item.relative_to(mod_folder) exists = (output / rel_path).exists() is_log = str(rel_path).startswith("logs") is_opt = str(rel_path).startswith("options") is_meta = str(rel_path).startswith("meta") is_extra = (len(rel_path.parts) == 1 and rel_path.suffix != ".txt" and not item.is_dir()) if exists or is_log or is_extra or is_meta or is_opt: continue if item.is_dir(): (output / rel_path).mkdir(parents=True, exist_ok=True) elif item.is_file(): try: link_or_copy(str(item), str(output / rel_path)) except OSError: if link_or_copy is os.link: link_or_copy = copyfile link_or_copy(str(item), str(output / rel_path)) else: raise
def link_master_mod(output: Path = None): if not output: output = util.get_cemu_dir() / 'graphicPacks' / 'BreathOfTheWild_BCML' if output.exists(): shutil.rmtree(str(output), ignore_errors=True) output.mkdir(parents=True, exist_ok=True) mod_folders: List[Path] = sorted( [item for item in util.get_modpack_dir().glob('*') if item.is_dir()], reverse=True) shutil.copy(str(util.get_master_modpack_dir() / 'rules.txt'), str(output / 'rules.txt')) for mod_folder in mod_folders: for item in mod_folder.rglob('**/*'): rel_path = item.relative_to(mod_folder) if (output / rel_path).exists()\ or (str(rel_path).startswith('logs'))\ or (len(rel_path.parts) == 1 and rel_path.suffix != '.txt'): continue if item.is_dir(): (output / rel_path).mkdir(parents=True, exist_ok=True) elif item.is_file(): os.link(str(item), str(output / rel_path))
def convert_old_mods(source: Path = None): mod_dir = util.get_modpack_dir() old_path = source or util.get_cemu_dir() / "graphicPacks" / "BCML" print("Copying old mods...") shutil.rmtree(mod_dir, ignore_errors=True) shutil.copytree(old_path, mod_dir) print("Converting old mods...") for i, mod in enumerate( sorted({ d for d in mod_dir.glob("*") if d.is_dir() and d.name != "9999_BCML" })): print(f"Converting {mod.name[4:]}") try: convert_old_mod(mod, True) except Exception as err: shutil.rmtree(mod) install.refresh_merges() raise RuntimeError( f"BCML was unable to convert {mod.name[4:]}. Error: {str(err)}. Your old " f"mods have not been modified. {i} mod(s) were successfully imported." ) from err shutil.rmtree(old_path, ignore_errors=True)
def install_mod( mod: Path, options: dict = None, selects: dict = None, pool: Optional[multiprocessing.pool.Pool] = None, insert_priority: int = 0, merge_now: bool = False, updated: bool = False, ): if not insert_priority: insert_priority = get_next_priority() try: if isinstance(mod, str): mod = Path(mod) if mod.is_file(): print("Opening mod...") tmp_dir = open_mod(mod) elif mod.is_dir(): if not ((mod / "rules.txt").exists() or (mod / "info.json").exists()): print( f"Cannot open mod at {str(mod)}, no rules.txt or info.json found" ) return print(f"Loading mod from {str(mod)}...") tmp_dir = Path(mkdtemp()) if tmp_dir.exists(): shutil.rmtree(tmp_dir) shutil.copytree(str(mod), str(tmp_dir)) if (mod / "rules.txt").exists() and not (mod / "info.json").exists(): print("Upgrading old mod format...") upgrade.convert_old_mod(mod, delete_old=True) else: print(f"Error: {str(mod)} is neither a valid file nor a directory") return except Exception as err: # pylint: disable=broad-except raise util.InstallError(err) from err if not options: options = {"options": {}, "disable": []} this_pool: Optional[multiprocessing.pool.Pool] = None # type: ignore try: rules = json.loads((tmp_dir / "info.json").read_text("utf-8")) mod_name = rules["name"].strip(" '\"").replace("_", "") print(f"Identified mod: {mod_name}") if rules["depends"]: try: installed_metas = { v[0]: v[1] for m in util.get_installed_mods() for v in util.BcmlMod.meta_from_id(m.id) } except (IndexError, TypeError) as err: raise RuntimeError( f"This BNP has invalid or corrupt dependency data.") for depend in rules["depends"]: depend_name, depend_version = util.BcmlMod.meta_from_id(depend) if (depend_name not in installed_metas) or ( depend_name in installed_metas and depend_version > installed_metas[depend_name]): raise RuntimeError( f"{mod_name} requires {depend_name} version {depend_version}, " f"but it is not installed. Please install {depend_name} and " "try again.") friendly_plaform = lambda p: "Wii U" if p == "wiiu" else "Switch" user_platform = "wiiu" if util.get_settings("wiiu") else "switch" if rules["platform"] != user_platform: raise ValueError( f'"{mod_name}" is for {friendly_plaform(rules["platform"])}, not ' f" {friendly_plaform(user_platform)}.'") if "priority" in rules and rules["priority"] == "base": insert_priority = 100 logs = tmp_dir / "logs" if logs.exists(): print("Loading mod logs...") for merger in [ merger() # type: ignore for merger in mergers.get_mergers() if merger.NAME in options["disable"] ]: if merger.is_mod_logged(BcmlMod(tmp_dir)): (tmp_dir / "logs" / merger.log_name).unlink() else: this_pool = pool or Pool(maxtasksperchild=500) dev._pack_sarcs(tmp_dir, util.get_hash_table(util.get_settings("wiiu")), this_pool) generate_logs(tmp_dir=tmp_dir, options=options, pool=this_pool) if not util.get_settings("strip_gfx"): (tmp_dir / ".processed").touch() except Exception as err: # pylint: disable=broad-except try: name = mod_name except NameError: name = "your mod, the name of which could not be detected" raise util.InstallError(err, name) from err if selects: for opt_dir in { d for d in (tmp_dir / "options").glob("*") if d.is_dir() }: if opt_dir.name not in selects: shutil.rmtree(opt_dir, ignore_errors=True) else: file: Path for file in { f for f in opt_dir.rglob("**/*") if ("logs" not in f.parts and f.is_file()) }: out = tmp_dir / file.relative_to(opt_dir) out.parent.mkdir(parents=True, exist_ok=True) try: os.link(file, out) except FileExistsError: if file.suffix in util.SARC_EXTS: try: old_sarc = oead.Sarc( util.unyaz_if_needed(out.read_bytes())) except (ValueError, oead.InvalidDataError, RuntimeError): out.unlink() os.link(file, out) try: link_sarc = oead.Sarc( util.unyaz_if_needed(file.read_bytes())) except (ValueError, oead.InvalidDataError, RuntimeError): del old_sarc continue new_sarc = oead.SarcWriter.from_sarc(link_sarc) link_files = { f.name for f in link_sarc.get_files() } for sarc_file in old_sarc.get_files(): if sarc_file.name not in link_files: new_sarc.files[sarc_file.name] = bytes( sarc_file.data) del old_sarc del link_sarc out.write_bytes(new_sarc.write()[1]) del new_sarc else: out.unlink() os.link(file, out) rstb_path = (tmp_dir / util.get_content_path() / "System" / "Resource" / "ResourceSizeTable.product.srsizetable") if rstb_path.exists(): rstb_path.unlink() priority = insert_priority print(f"Assigned mod priority of {priority}") mod_id = util.get_mod_id(mod_name, priority) mod_dir = util.get_modpack_dir() / mod_id try: if not updated: for existing_mod in util.get_installed_mods(True): if existing_mod.priority >= priority: existing_mod.change_priority(existing_mod.priority + 1) if (tmp_dir / "patches").exists() and not util.get_settings("no_cemu"): patch_dir = (util.get_cemu_dir() / "graphicPacks" / f"bcmlPatches" / util.get_safe_pathname(rules["name"])) patch_dir.mkdir(parents=True, exist_ok=True) for file in { f for f in (tmp_dir / "patches").rglob("*") if f.is_file() }: out = patch_dir / file.relative_to(tmp_dir / "patches") out.parent.mkdir(parents=True, exist_ok=True) shutil.copyfile(file, out) mod_dir.parent.mkdir(parents=True, exist_ok=True) print(f"Moving mod to {str(mod_dir)}...") if mod.is_file(): try: shutil.move(str(tmp_dir), str(mod_dir)) except Exception: # pylint: disable=broad-except try: shutil.rmtree(str(mod_dir)) shutil.copytree(str(tmp_dir), str(mod_dir)) shutil.rmtree(str(tmp_dir), ignore_errors=True) except Exception: # pylint: disable=broad-except raise OSError( "BCML could not transfer your mod from the temp directory to the" " BCML directory.") elif mod.is_dir(): shutil.copytree(str(tmp_dir), str(mod_dir)) shutil.rmtree(tmp_dir, ignore_errors=True) rules["priority"] = priority (mod_dir / "info.json").write_text(json.dumps(rules, ensure_ascii=False, indent=2), encoding="utf-8") (mod_dir / "options.json").write_text(json.dumps(options, ensure_ascii=False, indent=2), encoding="utf-8") output_mod = BcmlMod(mod_dir) try: util.get_mod_link_meta(rules) util.get_mod_preview(output_mod) except Exception: # pylint: disable=broad-except pass except Exception as err: # pylint: disable=broad-except if mod_dir.exists(): try: uninstall_mod(mod_dir, wait_merge=True) except Exception: # pylint: disable=broad-except shutil.rmtree(str(mod_dir)) raise util.InstallError(err, mod_name) from err try: if merge_now: for merger in [m() for m in mergers.get_mergers()]: if this_pool or pool: merger.set_pool(this_pool or pool) if merger.NAME in options["options"]: merger.set_options(options["options"][merger.NAME]) merger.perform_merge() except Exception as err: # pylint: disable=broad-except raise util.MergeError(err) from err if this_pool and not pool: this_pool.close() this_pool.join() return output_mod
def get_next_priority() -> int: i = 100 while list(util.get_modpack_dir().glob(f"{i:04}_*")): i += 1 return i
def uninstall_all(self): for folder in { d for d in util.get_modpack_dir().glob("*") if d.is_dir() }: rmtree(folder)
def get_next_priority() -> int: """ Gets the next available mod priority """ i = 100 while list(util.get_modpack_dir().glob(f'{i:04}_*')): i += 1 return i
def install_mod(mod: Path, verbose: bool = False, options: dict = None, wait_merge: bool = False, insert_priority: int = 0): """ Installs a graphic pack mod, merging RSTB changes and optionally packs and texts :param mod: Path to the mod to install. Must be a RAR, 7z, or ZIP archive or a graphicpack directory containing a rules.txt file. :type mod: class:`pathlib.Path` :param verbose: Whether to display more detailed output, defaults to False. :type verbose: bool, optional :param wait_merge: Install mod and log changes, but wait to run merge manually, defaults to False. :type wait_merge: bool, optional :param insert_priority: Insert mod(s) at priority specified, defaults to get_next_priority(). :type insert_priority: int """ if insert_priority == 0: insert_priority = get_next_priority() util.create_bcml_graphicpack_if_needed() if isinstance(mod, str): mod = Path(mod) if mod.is_file(): print('Extracting mod...') tmp_dir = open_mod(mod) elif mod.is_dir(): if (mod / 'rules.txt').exists(): print(f'Loading mod from {str(mod)}...') tmp_dir = util.get_work_dir() / f'tmp_{mod.name}' shutil.copytree(str(mod), str(tmp_dir)) else: print(f'Cannot open mod at {str(mod)}, no rules.txt found') return else: print(f'Error: {str(mod)} is neither a valid file nor a directory') return pool: Pool = None try: rules = util.RulesParser() rules.read(tmp_dir / 'rules.txt') mod_name = str(rules['Definition']['name']).strip(' "\'') print(f'Identified mod: {mod_name}') logs = tmp_dir / 'logs' if logs.exists(): print('This mod supports Quick Install! Loading changes...') for merger in [merger() for merger in mergers.get_mergers() \ if merger.NAME in options['disable']]: if merger.is_mod_logged(BcmlMod('', 0, tmp_dir)): (tmp_dir / 'logs' / merger.log_name()).unlink() else: pool = Pool(cpu_count()) generate_logs(tmp_dir=tmp_dir, verbose=verbose, options=options, original_pool=pool) except Exception as e: # pylint: disable=broad-except if hasattr(e, 'error_text'): raise e clean_error = RuntimeError() try: name = mod_name except NameError: name = 'your mod, the name of which could not be detected' clean_error.error_text = ( f'There was an error while processing {name}. ' 'This could indicate there is a problem with the mod itself, ' 'but it could also reflect a new or unusual edge case BCML does ' 'not anticipate. Here is the error:\n\n' f'{traceback.format_exc(limit=-4)}') raise clean_error priority = insert_priority print(f'Assigned mod priority of {priority}') mod_id = util.get_mod_id(mod_name, priority) mod_dir = util.get_modpack_dir() / mod_id try: for existing_mod in util.get_installed_mods(): if existing_mod.priority >= priority: priority_shifted = existing_mod.priority + 1 new_id = util.get_mod_id(existing_mod.name, priority_shifted) new_path = util.get_modpack_dir() / new_id shutil.move(str(existing_mod.path), str(new_path)) existing_mod_rules = util.RulesParser() existing_mod_rules.read(str(new_path / 'rules.txt')) existing_mod_rules['Definition']['fsPriority'] = str( priority_shifted) with (new_path / 'rules.txt').open('w', encoding='utf-8') as r_file: existing_mod_rules.write(r_file) mod_dir.parent.mkdir(parents=True, exist_ok=True) print() print(f'Moving mod to {str(mod_dir)}...') if mod.is_file(): try: shutil.move(str(tmp_dir), str(mod_dir)) except Exception: # pylint: disable=broad-except try: shutil.copytree(str(tmp_dir), str(mod_dir)) try: shutil.rmtree(str(tmp_dir)) except Exception: # pylint: disable=broad-except pass except Exception: # pylint: disable=broad-except raise OSError( 'BCML could not transfer your mod from the temp directory ' 'to the BCML directory.') elif mod.is_dir(): shutil.copytree(str(tmp_dir), str(mod_dir)) rulepath = os.path.basename(rules['Definition']['path']).replace( '"', '') rules['Definition']['path'] = f'{{BCML: DON\'T TOUCH}}/{rulepath}' rules['Definition']['fsPriority'] = str(priority) with Path(mod_dir / 'rules.txt').open('w', encoding='utf-8') as r_file: rules.write(r_file) output_mod = BcmlMod(mod_name, priority, mod_dir) try: util.get_mod_link_meta(rules) util.get_mod_preview(output_mod, rules) except Exception: # pylint: disable=broad-except pass print(f'Enabling {mod_name} in Cemu...') refresh_cemu_mods() except Exception: # pylint: disable=broad-except clean_error = RuntimeError() clean_error.error_text = ( f'There was an error installing {mod_name}. ' 'It processed successfully, but could not be added to your BCML ' 'mods. This may indicate a problem with your BCML installation. ' 'Here is the error:\n\n' f'{traceback.format_exc(limit=-4)}\n\n' f'{mod_name} is being removed and no changes will be made.') if mod_dir.exists(): try: uninstall_mod(mod_dir, wait_merge=True) except Exception: # pylint: disable=broad-except shutil.rmtree(str(mod_dir)) raise clean_error if wait_merge: print('Mod installed, merge still pending...') else: try: if not pool: pool = Pool(cpu_count) print('Performing merges...') if not options: options = {} if 'disable' not in options: options['disable'] = [] for merger in mergers.sort_mergers([cls() for cls in mergers.get_mergers() \ if cls.NAME not in options['disable']]): merger.set_pool(pool) if merger.NAME in options: merger.set_options(options[merger.NAME]) if merger.is_mod_logged(output_mod): merger.perform_merge() print() print(f'{mod_name} installed successfully!') pool.close() pool.join() except Exception: # pylint: disable=broad-except clean_error = RuntimeError() clean_error.error_text = ( f'There was an error merging {mod_name}. ' 'It processed and installed without error, but it has not ' 'successfully merged with your other mods. ' 'Here is the error:\n\n' f'{traceback.format_exc(limit=-4)}\n\n' f'To protect your mod setup, BCML will remove {mod_name} ' 'and remerge.') try: uninstall_mod(mod_dir) except FileNotFoundError: pass raise clean_error return output_mod