kmoody/libretro
1
0
Fork 0
mirror of https://github.com/Abdess/retroarch_system.git synced 2026-04-13 12:22:33 -05:00
Code Issues Packages Projects Releases Wiki Activity

feat: include readme.txt in pack zips

Browse Source
This commit is contained in:
Abdessamad Derraz
2026-03-28 18:11:37 +01:00
parent 6ba2519c4e
commit f453a7c750
1 changed files with 33 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
scripts/generate_pack.py
View File

@@ -684,6 +684,37 @@ def generate_pack(
zf.write(src, full) zf.write(src, full)
total_files += 1 total_files += 1
# README.txt for users
extract_paths = {
"retroarch": "system/", "lakka": "system/",
"batocera": "/userdata/bios/", "recalbox": "/recalbox/share/bios/",
"emudeck": "Emulation/bios/", "retrobat": "bios/",
"retrodeck": "~/retrodeck/bios/", "romm": "bios/",
"bizhawk": "Firmware/", "retropie": "BIOS/",
}
extract_to = extract_paths.get(platform_name, f"{base_dest}/")
num_systems = len(pack_systems)
readme_text = (
f"{'=' * 43}\n"
f" RETROBIOS - {platform_display} BIOS Pack\n"
f" {total_files} files for {num_systems} systems\n"
f"{'=' * 43}\n\n"
f"HOW TO INSTALL\n\n"
f" 1. Open the \"{base_dest or 'files'}\" folder in this archive\n"
f" 2. Select everything inside (Ctrl+A)\n"
f" 3. Copy (Ctrl+C)\n"
f" 4. Go to: {extract_to}\n"
f" 5. Paste (Ctrl+V)\n\n"
f"IMPORTANT\n"
f" - Copy the FILES, not the folder itself\n"
f" - If asked to replace, click Yes\n\n"
f"AUTOMATIC INSTALL (recommended)\n"
f" curl -fsSL https://raw.githubusercontent.com/Abdess/retrobios/main/install.sh | sh\n\n"
f"PROJECT: https://github.com/Abdess/retrobios\n"
f"{'=' * 43}\n"
)
zf.writestr("README.txt", readme_text)
files_ok = sum(1 for s in file_status.values() if s == "ok") files_ok = sum(1 for s in file_status.values() if s == "ok")
files_untested = sum(1 for s in file_status.values() if s == "untested") files_untested = sum(1 for s in file_status.values() if s == "untested")
files_miss = sum(1 for s in file_status.values() if s == "missing") files_miss = sum(1 for s in file_status.values() if s == "missing")
@@ -1893,7 +1924,7 @@ def verify_pack(zip_path: str, db: dict) -> tuple[bool, dict]:
if info.is_dir(): if info.is_dir():
continue continue
name = info.filename name = info.filename
if name.startswith("INSTRUCTIONS_") or name == "manifest.json": if name.startswith("INSTRUCTIONS_") or name in ("manifest.json", "README.txt"):
continue continue
with zf.open(info) as f: with zf.open(info) as f:
sha1_h = hashlib.sha1() sha1_h = hashlib.sha1()
@@ -2057,7 +2088,7 @@ def verify_pack_against_platform(
# Zero-byte check (exclude Dolphin GraphicMods markers) # Zero-byte check (exclude Dolphin GraphicMods markers)
for info in zf.infolist(): for info in zf.infolist():
if info.file_size == 0 and not info.is_dir(): if info.file_size == 0 and not info.is_dir():
if "GraphicMods" not in info.filename and info.filename != "manifest.json": if "GraphicMods" not in info.filename and info.filename not in ("manifest.json", "README.txt"):
errors.append(f"zero-byte: {info.filename}") errors.append(f"zero-byte: {info.filename}")
# 1. Baseline file presence # 1. Baseline file presence