Files
NX2navi/tools/romfs_index.py
chrg6 c8738a948c Name the settings, files and tools NX2navi
The names are NX2NAVI, NX2navi or nx2navi: the settings prefix (NX2NAVI_*), the ini file
(nx2navi.ini), the shader translator (nx2navi_xlate), the Windows resources, the installer and the docs. The 8-byte
file magics keep their size (NX2NSANS, NX2NSPRG, NX2NSPRP, NX2NPKEY, NX2NRFS1), so caches and the RomFS index from
older builds are not read. cfg.c and the settings pages took the prefix length as 5; it now follows the prefix.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-07 05:04:39 -05:00

111 lines
4.8 KiB
Python

"""Build the RomFS index the runtime binary-searches (runtime/romfs.c) and its romfs_config.h.
Adapted from MacNativeGames games/<game>/scripts/prepare_romfs_backend.py @ b75be8cf (MIT, Copyright (c) 2026
MacNativeGames contributors).
Input: <romfs>/index.json ({status, romfs_size, romfs_sha256, files: [{path, offset, size}]}) as tools/extract.py
writes it, and <romfs>/romfs.bin, whose size must match. Output, both in the build directory (never in the repo):
romfs-index.bin NX2NRFS1 layout: header <8sQQ (magic, count, strings offset), count 24-byte rows <QQII (offset,
size, name offset, name length including the NUL), then the NUL-terminated names; rows sorted by
the UTF-8 bytes of the path, which is the order strcmp sees
romfs_config.h ROMFS_IMAGE_SIZE, ROMFS_IMAGE_SHA256, ROMFS_INDEX_SHA256, ROMFS_FILE_COUNT
Both are rewritten only when their bytes change, so Ninja does not rebuild romfs.c for nothing.
.venv\\Scripts\\python tools\\romfs_index.py --romfs build\\extracted\\v121\\romfs --out build\\v121
Standard library only.
"""
import argparse
import hashlib
import json
import struct
import sys
import time
from pathlib import Path
from check_content import GENERATED_MARKER
MAGIC = b'NX2NRFS1'
HEADER = struct.Struct('<8sQQ')
ROW = struct.Struct('<QQII')
def build_index(manifest):
"""The index bytes for an index.json manifest; exits on a malformed one."""
files = sorted(manifest['files'], key=lambda e: e['path'].encode())
size = manifest['romfs_size']
strings = bytearray()
rows = bytearray()
previous = None
for item in files:
path = item['path']
name = path.encode()
if not name or name.startswith(b'/') or b'\\' in name or b'\0' in name:
sys.exit(f'romfs_index: malformed path in index.json (entry {len(rows) // ROW.size})')
if name == previous:
sys.exit('romfs_index: duplicate path in index.json')
previous = name
if item['offset'] < 0 or item['size'] < 0 or item['offset'] + item['size'] > size:
sys.exit(f'romfs_index: entry {len(rows) // ROW.size} lies outside the image')
rows += ROW.pack(item['offset'], item['size'], len(strings), len(name) + 1)
strings += name + b'\0'
return HEADER.pack(MAGIC, len(files), HEADER.size + len(rows)) + bytes(rows) + bytes(strings)
def write_if_changed(path, data):
if path.exists() and path.read_bytes() == data:
return
path.parent.mkdir(parents=True, exist_ok=True)
path.write_bytes(data)
def write(romfs, out):
"""Write romfs-index.bin and romfs_config.h into out. Returns (file count, index bytes, seconds)."""
t0 = time.monotonic()
manifest = json.loads((romfs / 'index.json').read_text(encoding='utf-8'))
if manifest.get('status') != 'pass':
sys.exit(f'romfs_index: {romfs / "index.json"} does not record a verified extraction')
image = romfs / 'romfs.bin'
if not image.is_file() or image.stat().st_size != manifest['romfs_size']:
sys.exit(f'romfs_index: {image} is missing or its size differs from index.json')
index = build_index(manifest)
count = len(manifest['files'])
write_if_changed(out / 'romfs-index.bin', index)
config = (f'// RomFS image and index identity, written by tools/romfs_index.py; do not edit. {GENERATED_MARKER}\n'
'#pragma once\n'
f'#define ROMFS_IMAGE_SIZE {manifest["romfs_size"]}ull\n'
f'#define ROMFS_IMAGE_SHA256 "{manifest["romfs_sha256"].lower()}"\n'
f'#define ROMFS_INDEX_SHA256 "{hashlib.sha256(index).hexdigest()}"\n'
f'#define ROMFS_FILE_COUNT {count}ull\n')
write_if_changed(out / 'romfs_config.h', config.encode())
return count, len(index), time.monotonic() - t0
def write_placeholder(out):
"""romfs_config.h without a RomFS (no extracted game on this machine): nx2navi.exe builds, and fs_init stops with a
named fatal."""
(out / 'romfs-index.bin').unlink(missing_ok=True)
config = (f'// No RomFS found by tools/romfs_index.py; do not edit. {GENERATED_MARKER}\n'
'#pragma once\n'
'#define ROMFS_MISSING 1\n'
'#define ROMFS_IMAGE_SIZE 0ull\n'
'#define ROMFS_IMAGE_SHA256 ""\n'
'#define ROMFS_INDEX_SHA256 ""\n'
'#define ROMFS_FILE_COUNT 0ull\n')
write_if_changed(out / 'romfs_config.h', config.encode())
def main():
ap = argparse.ArgumentParser(description=__doc__.splitlines()[0])
ap.add_argument('--romfs', type=Path, required=True, help='directory with romfs.bin and index.json')
ap.add_argument('--out', type=Path, required=True, help='build directory')
args = ap.parse_args()
count, size, dt = write(args.romfs.resolve(), args.out.resolve())
print(f'romfs index: {count} files, {size:,} bytes, {dt:.1f} s')
if __name__ == '__main__':
main()