def main(argv: List[str]) -> None: """Main VRAD script.""" LOGGER.info( "BEE{} VRAD hook initiallised, srctools v{}, Hammer Addons v{}", utils.BEE_VERSION, srctools.__version__, version_haddons, ) # Warn if srctools Cython code isn't installed. utils.check_cython(LOGGER.warning) args = " ".join(argv) fast_args = argv[1:] full_args = argv[1:] if not fast_args: # No arguments! LOGGER.info( 'No arguments!\n' "The BEE2 VRAD takes all the regular VRAD's " 'arguments, with some extra arguments:\n' '-force_peti: Force enabling map conversion. \n' "-force_hammer: Don't convert the map at all.\n" "If not specified, the map name must be \"preview.bsp\" to be " "treated as PeTI." ) sys.exit() # The path is the last argument to vrad # P2 adds wrong slashes sometimes, so fix that. fast_args[-1] = path = os.path.normpath(argv[-1]) LOGGER.info("Map path is " + path) LOGGER.info('Loading Settings...') config = ConfigFile('compile.cfg') for a in fast_args[:]: folded_a = a.casefold() if folded_a.casefold() in ( "-final", "-staticproplighting", "-staticproppolys", "-textureshadows", ): # remove final parameters from the modified arguments fast_args.remove(a) elif folded_a == '-both': # LDR Portal 2 isn't actually usable, so there's not much # point compiling for it. pos = fast_args.index(a) fast_args[pos] = full_args[pos] = '-hdr' elif a in ('-force_peti', '-force_hammer', '-no_pack'): # we need to strip these out, otherwise VRAD will get confused fast_args.remove(a) full_args.remove(a) fast_args = ['-bounce', '2', '-noextra'] + fast_args # Fast args: -bounce 2 -noextra -game $gamedir $path\$file # Final args: -both -final -staticproplighting -StaticPropPolys # -textureshadows -game $gamedir $path\$file if not path.endswith(".bsp"): path += ".bsp" if not os.path.exists(path): raise ValueError('"{}" does not exist!'.format(path)) if not os.path.isfile(path): raise ValueError('"{}" is not a file!'.format(path)) LOGGER.info('Reading BSP') bsp_file = BSP(path) # If VBSP marked it as Hammer, trust that. if srctools.conv_bool(bsp_file.ents.spawn['BEE2_is_peti']): is_peti = True # Detect preview via knowing the bsp name. If we are in preview, # check the config file to see what was specified there. if os.path.basename(path) == "preview.bsp": edit_args = not config.get_bool('General', 'vrad_force_full') # If shift is held, reverse. if utils.check_shift(): LOGGER.info('Shift held, inverting configured lighting option!') edit_args = not edit_args else: # publishing - always force full lighting. edit_args = False else: is_peti = edit_args = False if '-force_peti' in args or '-force_hammer' in args: # we have override commands! if '-force_peti' in args: LOGGER.warning('OVERRIDE: Applying cheap lighting!') is_peti = edit_args = True else: LOGGER.warning('OVERRIDE: Preserving args!') is_peti = edit_args = False LOGGER.info('Final status: is_peti={}, edit_args={}', is_peti, edit_args) if not is_peti: # Skip everything, if the user wants these features install the Hammer Addons postcompiler. LOGGER.info("Hammer map detected! Skipping all transforms.") run_vrad(full_args) return # Grab the currently mounted filesystems in P2. game = find_gameinfo(argv) root_folder = game.path.parent fsys = game.get_filesystem() # Special case - move the BEE2 filesystem FIRST, so we always pack files found there. for child_sys in fsys.systems[:]: if 'bee2' in child_sys[0].path.casefold(): fsys.systems.remove(child_sys) fsys.systems.insert(0, child_sys) zip_data = BytesIO() zip_data.write(bsp_file.get_lump(BSP_LUMPS.PAKFILE)) zipfile = ZipFile(zip_data) # Mount the existing packfile, so the cubemap files are recognised. fsys.add_sys(ZipFileSystem('<BSP pakfile>', zipfile)) LOGGER.info('Done!') LOGGER.debug('Filesystems:') for child_sys in fsys.systems[:]: LOGGER.debug('- {}: {!r}', child_sys[1], child_sys[0]) LOGGER.info('Reading our FGD files...') fgd = FGD.engine_dbase() packlist = PackList(fsys) LOGGER.info('Reading soundscripts...') packlist.load_soundscript_manifest( str(root_folder / 'bin/bee2/sndscript_cache.vdf') ) # We need to add all soundscripts in scripts/bee2_snd/ # This way we can pack those, if required. for soundscript in fsys.walk_folder('scripts/bee2_snd/'): if soundscript.path.endswith('.txt'): packlist.load_soundscript(soundscript, always_include=False) LOGGER.info('Reading particles....') packlist.load_particle_manifest() LOGGER.info('Loading transforms...') load_transforms() LOGGER.info('Checking for music:') music.generate(bsp_file.ents, packlist) LOGGER.info('Run transformations...') run_transformations(bsp_file.ents, fsys, packlist, bsp_file, game) LOGGER.info('Scanning map for files to pack:') packlist.pack_from_bsp(bsp_file) packlist.pack_fgd(bsp_file.ents, fgd) packlist.eval_dependencies() LOGGER.info('Done!') packlist.write_soundscript_manifest() packlist.write_particles_manifest(f'maps/{Path(path).stem}_particles.txt') # We need to disallow Valve folders. pack_whitelist: set[FileSystem] = set() pack_blacklist: set[FileSystem] = set() # Exclude absolutely everything except our folder. for child_sys, _ in fsys.systems: # Add 'bee2/' and 'bee2_dev/' only. if ( isinstance(child_sys, RawFileSystem) and 'bee2' in os.path.basename(child_sys.path).casefold() ): pack_whitelist.add(child_sys) else: pack_blacklist.add(child_sys) if config.get_bool('General', 'packfile_dump_enable'): dump_loc = Path(config.get_val( 'General', 'packfile_dump_dir', '../dump/' )).absolute() else: dump_loc = None if '-no_pack' not in args: # Cubemap files packed into the map already. existing = set(bsp_file.pakfile.namelist()) LOGGER.info('Writing to BSP...') packlist.pack_into_zip( bsp_file, ignore_vpk=True, whitelist=pack_whitelist, blacklist=pack_blacklist, dump_loc=dump_loc, ) LOGGER.info('Packed files:\n{}', '\n'.join( set(bsp_file.pakfile.namelist()) - existing )) LOGGER.info('Writing BSP...') bsp_file.save() LOGGER.info(' - BSP written!') screenshot.modify(config, game.path) if edit_args: LOGGER.info("Forcing Cheap Lighting!") run_vrad(fast_args) else: LOGGER.info("Publishing - Full lighting enabled! (or forced to do so)") run_vrad(full_args) LOGGER.info("BEE2 VRAD hook finished!")
def main(argv: List[str]) -> None: LOGGER.info('BEE2 VRAD hook started!') args = " ".join(argv) fast_args = argv[1:] full_args = argv[1:] if not fast_args: # No arguments! LOGGER.info( 'No arguments!\n' "The BEE2 VRAD takes all the regular VRAD's " 'arguments, with some extra arguments:\n' '-force_peti: Force enabling map conversion. \n' "-force_hammer: Don't convert the map at all.\n" "If not specified, the map name must be \"preview.bsp\" to be " "treated as PeTI.") sys.exit() # The path is the last argument to vrad # P2 adds wrong slashes sometimes, so fix that. fast_args[-1] = path = os.path.normpath(argv[-1]) # type: str LOGGER.info("Map path is " + path) load_config() for a in fast_args[:]: if a.casefold() in ( "-both", "-final", "-staticproplighting", "-staticproppolys", "-textureshadows", ): # remove final parameters from the modified arguments fast_args.remove(a) elif a in ('-force_peti', '-force_hammer', '-no_pack'): # we need to strip these out, otherwise VRAD will get confused fast_args.remove(a) full_args.remove(a) fast_args = ['-bounce', '2', '-noextra'] + fast_args # Fast args: -bounce 2 -noextra -game $gamedir $path\$file # Final args: -both -final -staticproplighting -StaticPropPolys # -textureshadows -game $gamedir $path\$file if not path.endswith(".bsp"): path += ".bsp" if not os.path.exists(path): raise ValueError('"{}" does not exist!'.format(path)) if not os.path.isfile(path): raise ValueError('"{}" is not a file!'.format(path)) # If VBSP thinks it's hammer, trust it. if CONF.bool('is_hammer', False): is_peti = edit_args = False else: is_peti = True # Detect preview via knowing the bsp name. If we are in preview, # check the config file to see what was specified there. if os.path.basename(path) == "preview.bsp": edit_args = not CONF.bool('force_full', False) else: # publishing - always force full lighting. edit_args = False if '-force_peti' in args or '-force_hammer' in args: # we have override commands! if '-force_peti' in args: LOGGER.warning('OVERRIDE: Applying cheap lighting!') is_peti = edit_args = True else: LOGGER.warning('OVERRIDE: Preserving args!') is_peti = edit_args = False LOGGER.info('Final status: is_peti={}, edit_args={}', is_peti, edit_args) # Grab the currently mounted filesystems in P2. game = find_gameinfo(argv) root_folder = game.path.parent fsys = game.get_filesystem() fsys_tag = fsys_mel = None if is_peti and 'mel_vpk' in CONF: fsys_mel = VPKFileSystem(CONF['mel_vpk']) fsys.add_sys(fsys_mel) if is_peti and 'tag_dir' in CONF: fsys_tag = RawFileSystem(CONF['tag_dir']) fsys.add_sys(fsys_tag) LOGGER.info('Reading BSP') bsp_file = BSP(path) bsp_ents = bsp_file.read_ent_data() zip_data = BytesIO() zip_data.write(bsp_file.get_lump(BSP_LUMPS.PAKFILE)) zipfile = ZipFile(zip_data, mode='a') # Mount the existing packfile, so the cubemap files are recognised. fsys.systems.append((ZipFileSystem('', zipfile), '')) fsys.open_ref() LOGGER.info('Done!') LOGGER.info('Reading our FGD files...') fgd = load_fgd() packlist = PackList(fsys) packlist.load_soundscript_manifest( str(root_folder / 'bin/bee2/sndscript_cache.vdf')) # We nee to add all soundscripts in scripts/bee2_snd/ # This way we can pack those, if required. for soundscript in fsys.walk_folder('scripts/bee2_snd/'): if soundscript.path.endswith('.txt'): packlist.load_soundscript(soundscript, always_include=False) if is_peti: LOGGER.info('Adding special packed files:') music_data = CONF.find_key('MusicScript', []) if music_data: packlist.pack_file('scripts/BEE2_generated_music.txt', PackType.SOUNDSCRIPT, data=generate_music_script( music_data, packlist)) for filename, arcname in inject_files(): LOGGER.info('Injecting "{}" into packfile.', arcname) with open(filename, 'rb') as f: packlist.pack_file(arcname, data=f.read()) LOGGER.info('Run transformations...') run_transformations(bsp_ents, fsys, packlist) LOGGER.info('Scanning map for files to pack:') packlist.pack_from_bsp(bsp_file) packlist.pack_fgd(bsp_ents, fgd) packlist.eval_dependencies() LOGGER.info('Done!') if is_peti: packlist.write_manifest() else: # Write with the map name, so it loads directly. packlist.write_manifest(os.path.basename(path)[:-4]) # We need to disallow Valve folders. pack_whitelist = set() # type: Set[FileSystem] pack_blacklist = set() # type: Set[FileSystem] if is_peti: pack_blacklist |= { RawFileSystem(root_folder / 'portal2_dlc2'), RawFileSystem(root_folder / 'portal2_dlc1'), RawFileSystem(root_folder / 'portal2'), RawFileSystem(root_folder / 'platform'), RawFileSystem(root_folder / 'update'), } if fsys_mel is not None: pack_whitelist.add(fsys_mel) if fsys_tag is not None: pack_whitelist.add(fsys_tag) if '-no_pack' not in args: # Cubemap files packed into the map already. existing = set(zipfile.infolist()) LOGGER.info('Writing to BSP...') packlist.pack_into_zip( zipfile, ignore_vpk=True, whitelist=pack_whitelist, blacklist=pack_blacklist, ) LOGGER.info( 'Packed files:\n{}', '\n'.join([ zipinfo.filename for zipinfo in zipfile.infolist() if zipinfo.filename not in existing ])) dump_files(zipfile) zipfile.close() # Finalise the zip modification # Copy the zipfile into the BSP file, and adjust the headers. bsp_file.lumps[BSP_LUMPS.PAKFILE].data = zip_data.getvalue() # Copy new entity data. bsp_file.lumps[BSP_LUMPS.ENTITIES].data = BSP.write_ent_data(bsp_ents) bsp_file.save() LOGGER.info(' - BSP written!') if is_peti: mod_screenshots() if edit_args: LOGGER.info("Forcing Cheap Lighting!") run_vrad(fast_args) else: if is_peti: LOGGER.info( "Publishing - Full lighting enabled! (or forced to do so)") else: LOGGER.info("Hammer map detected! Not forcing cheap lighting..") run_vrad(full_args) LOGGER.info("BEE2 VRAD hook finished!")
def main(argv: List[str]) -> None: LOGGER.info('BEE2 VRAD hook started!') args = " ".join(argv) fast_args = argv[1:] full_args = argv[1:] if not fast_args: # No arguments! LOGGER.info( 'No arguments!\n' "The BEE2 VRAD takes all the regular VRAD's " 'arguments, with some extra arguments:\n' '-force_peti: Force enabling map conversion. \n' "-force_hammer: Don't convert the map at all.\n" "If not specified, the map name must be \"preview.bsp\" to be " "treated as PeTI." ) sys.exit() # The path is the last argument to vrad # P2 adds wrong slashes sometimes, so fix that. fast_args[-1] = path = os.path.normpath(argv[-1]) # type: str LOGGER.info("Map path is " + path) load_config() for a in fast_args[:]: if a.casefold() in ( "-both", "-final", "-staticproplighting", "-staticproppolys", "-textureshadows", ): # remove final parameters from the modified arguments fast_args.remove(a) elif a in ('-force_peti', '-force_hammer', '-no_pack'): # we need to strip these out, otherwise VRAD will get confused fast_args.remove(a) full_args.remove(a) fast_args = ['-bounce', '2', '-noextra'] + fast_args # Fast args: -bounce 2 -noextra -game $gamedir $path\$file # Final args: -both -final -staticproplighting -StaticPropPolys # -textureshadows -game $gamedir $path\$file if not path.endswith(".bsp"): path += ".bsp" if not os.path.exists(path): raise ValueError('"{}" does not exist!'.format(path)) if not os.path.isfile(path): raise ValueError('"{}" is not a file!'.format(path)) # If VBSP thinks it's hammer, trust it. if CONF.bool('is_hammer', False): is_peti = edit_args = False else: is_peti = True # Detect preview via knowing the bsp name. If we are in preview, # check the config file to see what was specified there. if os.path.basename(path) == "preview.bsp": edit_args = not CONF.bool('force_full', False) else: # publishing - always force full lighting. edit_args = False if '-force_peti' in args or '-force_hammer' in args: # we have override commands! if '-force_peti' in args: LOGGER.warning('OVERRIDE: Applying cheap lighting!') is_peti = edit_args = True else: LOGGER.warning('OVERRIDE: Preserving args!') is_peti = edit_args = False LOGGER.info('Final status: is_peti={}, edit_args={}', is_peti, edit_args) # Grab the currently mounted filesystems in P2. game = find_gameinfo(argv) root_folder = game.path.parent fsys = game.get_filesystem() fsys_tag = fsys_mel = None if is_peti and 'mel_vpk' in CONF: fsys_mel = VPKFileSystem(CONF['mel_vpk']) fsys.add_sys(fsys_mel) if is_peti and 'tag_dir' in CONF: fsys_tag = RawFileSystem(CONF['tag_dir']) fsys.add_sys(fsys_tag) LOGGER.info('Reading BSP') bsp_file = BSP(path) bsp_ents = bsp_file.read_ent_data() zip_data = BytesIO() zip_data.write(bsp_file.get_lump(BSP_LUMPS.PAKFILE)) zipfile = ZipFile(zip_data, mode='a') # Mount the existing packfile, so the cubemap files are recognised. fsys.systems.append((ZipFileSystem('', zipfile), '')) fsys.open_ref() LOGGER.info('Done!') LOGGER.info('Reading our FGD files...') fgd = load_fgd() packlist = PackList(fsys) packlist.load_soundscript_manifest( str(root_folder / 'bin/bee2/sndscript_cache.vdf') ) # We nee to add all soundscripts in scripts/bee2_snd/ # This way we can pack those, if required. for soundscript in fsys.walk_folder('scripts/bee2_snd/'): if soundscript.path.endswith('.txt'): packlist.load_soundscript(soundscript, always_include=False) if is_peti: LOGGER.info('Adding special packed files:') music_data = CONF.find_key('MusicScript', []) if music_data: packlist.pack_file( 'scripts/BEE2_generated_music.txt', PackType.SOUNDSCRIPT, data=generate_music_script(music_data, packlist) ) for filename, arcname in inject_files(): LOGGER.info('Injecting "{}" into packfile.', arcname) with open(filename, 'rb') as f: packlist.pack_file(arcname, data=f.read()) LOGGER.info('Run transformations...') run_transformations(bsp_ents, fsys, packlist) LOGGER.info('Scanning map for files to pack:') packlist.pack_from_bsp(bsp_file) packlist.pack_fgd(bsp_ents, fgd) packlist.eval_dependencies() LOGGER.info('Done!') if is_peti: packlist.write_manifest() else: # Write with the map name, so it loads directly. packlist.write_manifest(os.path.basename(path)[:-4]) # We need to disallow Valve folders. pack_whitelist = set() # type: Set[FileSystem] pack_blacklist = set() # type: Set[FileSystem] if is_peti: pack_blacklist |= { RawFileSystem(root_folder / 'portal2_dlc2'), RawFileSystem(root_folder / 'portal2_dlc1'), RawFileSystem(root_folder / 'portal2'), RawFileSystem(root_folder / 'platform'), RawFileSystem(root_folder / 'update'), } if fsys_mel is not None: pack_whitelist.add(fsys_mel) if fsys_tag is not None: pack_whitelist.add(fsys_tag) if '-no_pack' not in args: # Cubemap files packed into the map already. existing = set(zipfile.infolist()) LOGGER.info('Writing to BSP...') packlist.pack_into_zip( zipfile, ignore_vpk=True, whitelist=pack_whitelist, blacklist=pack_blacklist, ) LOGGER.info('Packed files:\n{}', '\n'.join([ zipinfo.filename for zipinfo in zipfile.infolist() if zipinfo.filename not in existing ])) dump_files(zipfile) zipfile.close() # Finalise the zip modification # Copy the zipfile into the BSP file, and adjust the headers. bsp_file.lumps[BSP_LUMPS.PAKFILE].data = zip_data.getvalue() # Copy new entity data. bsp_file.lumps[BSP_LUMPS.ENTITIES].data = BSP.write_ent_data(bsp_ents) bsp_file.save() LOGGER.info(' - BSP written!') if is_peti: mod_screenshots() if edit_args: LOGGER.info("Forcing Cheap Lighting!") run_vrad(fast_args) else: if is_peti: LOGGER.info("Publishing - Full lighting enabled! (or forced to do so)") else: LOGGER.info("Hammer map detected! Not forcing cheap lighting..") run_vrad(full_args) LOGGER.info("BEE2 VRAD hook finished!")