Files
Neutron/tools/extractors/prepare.py
T

133 lines
8.3 KiB
Python

#!/usr/bin/env python3
"""Prepare local scene/audio assets without modifying the original installation."""
import argparse
import json
from pathlib import Path
from omt import Database, export_scene, extract
from ase import export_ase
from png import read_png
from entities import prepare_entities
from models import prepare_models
from ui import export_ui
from gadget_resources import export_gadget_resources
from gadget_followup_assets import export_meter
from bubble_resources import export_bubble
from baseball_resources import export_baseball
from rocketship_resources import export_rocketship
from grappler_resources import export_grappler
from scooter_resources import export_scooter
from sound_bank import export_sound_bank
def find_archive(original: Path, name: str) -> Path:
matches = [p for p in (original / 'omt').iterdir()
if p.name.casefold() == (name if name.casefold().endswith('.omt') else name + '.omt').casefold()]
if len(matches) != 1:
raise ValueError(f'Expected exactly one archive for {name}, found {len(matches)}')
return matches[0]
def prepare_actor(original: Path, output: Path, name: str, texture_name: str, actions: dict, base_name: str | None = None,
ignored_animations: tuple[str, ...] = ()):
"""Explicit EXE registration mappings; no texture guessed from ASE adjacency."""
target = output / 'actors' / name
target.mkdir(parents=True, exist_ok=True)
texture_source = next(p for p in (original/'png').iterdir() if p.name.casefold() == texture_name.casefold())
texture = read_png(texture_source)
(target/'texture.rgba').write_bytes(texture.pop('rgba'))
base_name = base_name or next(iter(actions.values()))
base = next(p for p in (original/'ASE').iterdir() if p.stem.casefold() == base_name.casefold())
for stem in dict.fromkeys(actions.values()):
source = next(p for p in (original/'ASE').iterdir() if p.stem.casefold() == stem.casefold())
manifest = export_ase(source, target/stem, base)
manifest['texture'] = {'path': '../texture.rgba', **texture}
(target/stem/'animation.json').write_text(json.dumps(manifest, indent=2)+'\n')
(target/'family.json').write_text(json.dumps({'default': next(iter(actions)),
'actions': {key: value+'/animation.json' for key, value in actions.items()},
'ignoredAnimations': list(ignored_animations)}, indent=2)+'\n')
def main():
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument('--original', type=Path, default=Path('../Original'))
parser.add_argument('--output', type=Path, default=Path('artifacts/extracted'))
parser.add_argument('--scenes', nargs='+', default=['level1b', 'VR01'])
parser.add_argument('--all-scenes', action='store_true', help='Prepare every supplied GAM/OMT scene pair')
parser.add_argument('--audio', nargs='*', default=['sounds', 'musicjimmyshouse', 'musicneighborhood'])
parser.add_argument('--animations', nargs='*', default=['jimstop', 'jimrun', 'jimjump', 'jimscratch', 'jimbackpedal', 'jimfall', 'jimtalk', 'jimfly', 'jimshoot', 'jimleft', 'jimright'])
args = parser.parse_args()
if args.output.resolve().is_relative_to(args.original.resolve()):
parser.error('Output must be outside the original installation')
if args.all_scenes:
args.scenes = sorted((p.stem for p in (args.original/'gam').iterdir() if p.suffix.casefold()=='.gam'), key=str.casefold)
catalog = {'prepared': [], 'unavailable': []}
for name in args.scenes:
try:
source = find_archive(args.original, name)
except ValueError:
if not args.all_scenes:
raise
# GAM entities and OMT geometry are distinct. The executable registers
# level3b/3e, but their use in normal progression is not established.
# Report the absent geometry without calling it required game content.
catalog['unavailable'].append({'level': name+'.gam', 'archive': name+'.omt',
'reason': 'GAM supplied; matching geometry archive absent; gameplay use unverified'})
print(f'{name}.gam is supplied; no matching {name}.omt geometry archive '
'(gameplay use unverified; no substitution)')
continue
scene = export_scene(Database(source), args.output / source.stem)
print(f"{source.name}: {len(scene['indices'])//3} triangles, {len(scene['textures'])} textures")
report = prepare_entities(args.original, source.stem + '.gam', args.output / source.stem / 'entities', True)
print(f"{report['level']}: {len(report['resources'])} explicit entity resources")
models = prepare_models(args.original, source.stem + '.gam', args.output / source.stem / 'models')
print(f"{models['level']}: {len(models['actors'])} model actors; {len(models['unresolved'])} unresolved bindings")
catalog['prepared'].append({'level': name+'.gam', 'archive': source.name, 'scene': source.stem+'/scene.json'})
(args.output/'scene-catalog.json').write_text(json.dumps(catalog, indent=2)+'\n')
export_ui(Database(find_archive(args.original, 'screens')), args.output / 'ui', Database(args.original / 'alpha.omt'))
export_gadget_resources(Database(find_archive(args.original, 'screens')), args.output / 'gadgets')
export_meter(args.original, args.output / 'invisible-meter')
export_bubble(args.original,args.output/'bubble')
export_baseball(args.original,args.output/'baseball')
export_rocketship(args.original,args.output/'rocketship')
export_grappler(args.original,args.output/'grappler')
export_scooter(args.original,args.output/'scooter')
effects = export_sound_bank(args.original, args.output / 'effects')
print(f"SoundEffects.omt: {len(effects['resources'])} original sound identities")
for name in args.audio:
source = find_archive(args.original, name)
report = extract(Database(source), args.output / source.stem)
count = sum(1 for e in report['entries'] if 'audio' in e)
print(f'{source.name}: {count} audio resources')
if args.animations:
texture_source = next(p for p in (args.original/'png').iterdir() if p.name.casefold()=='jimycarl.png')
texture = read_png(texture_source)
target = args.output/'animations'
target.mkdir(parents=True,exist_ok=True)
(target/'jimycarl.rgba').write_bytes(texture.pop('rgba'))
base = next(p for p in (args.original/'ASE').iterdir() if p.name.casefold()=='jimstop.ase')
for name in args.animations:
matches = [p for p in (args.original/'ASE').iterdir() if p.stem.casefold()==name.casefold() and p.suffix.casefold()=='.ase']
if len(matches)!=1: raise ValueError(f'Expected one ASE for {name}')
manifest = export_ase(matches[0],target/name,base)
manifest['texture'] = {'path':'../jimycarl.rgba', **texture}
(target/name/'animation.json').write_text(json.dumps(manifest,indent=2)+'\n',encoding='utf-8')
print(f"{matches[0].name}: {len(manifest['frames'])} animation samples")
# EXE413D8C..413DF9 (Carl);41CDA0..41CE5F (Goddard high-detail clips).
prepare_actor(args.original, args.output, 'carl', 'carl.png', {
'STOP': 'carlstop', 'WALK': 'carlwalk', 'TALK': 'carltalk', 'INHALE': 'carlinhale',
'CHEER': 'carlcheer', 'TELE': 'carlteleport'})
prepare_actor(args.original, args.output, 'goddard', 'goddard02.png', {
'SIT': 'godsit', 'RUN': 'godrun', 'GROWL': 'godgrowl', 'WAG': 'godwag',
'EAT': 'godeat', 'FLY': 'godfly', 'POINT': 'godpoint'}, 'godpoint', ('STOP', 'WALK', 'TALK'))
prepare_actor(args.original, args.output, 'trophy', 'trophy.png', {'STOP': 'trophy'})
# C3DJetpackFire421F30..96: DEFAULT fire.ase, HINONE fire2.ase, fire.png.
prepare_actor(args.original, args.output, 'jetpack', 'fire.png', {'DEFAULT': 'fire', 'NONE': 'fire2'}, 'fire')
#Recovered C3DShrinkRay440000 and3SOL44C0B0 bindings; see docs/gameplay/.
prepare_actor(args.original, args.output, 'shrink-ray', 'ray0000.png', {'RAY': 'ray'})
prepare_actor(args.original, args.output, 'soldier', 'yoksold.png', {'WALK': 'soldwalk', 'SHRINK': 'soldshrink'}, 'soldatak')
prepare_actor(args.original, args.output, 'soldier-vr', 'vryoksoldier.png', {'WALK': 'soldwalk', 'SHRINK': 'soldshrink'}, 'soldatak')
if __name__ == '__main__': main()