Changelog

Version 2.7.0

  • Add srctools.sndscape, for parsing soundscape scripts.

  • Changed PackList.load_choreo_scenes() to warn if scenes.image is not found.

  • Change type for FGD keyvalue options to KVOption. Previous tuple attributes are deprecated.

  • Add support for orientedwidthheight(), orientedwidthheighthalf(), orientedboundingbox() and clusteredlight() Strata FGD helpers.

  • Add support for descriptions in spawnflags - displayed in Strata Source.

  • Add noinherit() FGD helper, for indicating values to avoid inheriting from base classes.

  • Add option to control double-quote escaping behaviour for FGDs, seperately to custom syntax.

  • Add support for parsing Strata’s Keyvalues-based cmdseq variant.

  • Allow customising the filename used for injected PackList files.

  • Add support for parsing Strata’s ‘colorvars’ system.

  • Add support for parsing Strata’s v2 and v3 tintable overlays BSP format.

  • Rearrange srctools.bsp.Overlay attributes, parse basis U/V out of the 4 handle positions.

  • Issue #43: Fix incorrect export of displacement triangle_tag values.

  • Issue #44: Fix VTF.read() not initalising hotspot_info and hotspot_flags.

  • Account for VBSP++’s --cullverts parameter, which discards the original faces lump.

Version 2.6.2

  • Fix unknown bits sometimes not round tripping through enum bitfields.

  • Fix incorrect parsing of the deprecated bbox() FGD helper.

  • Add support for saving/loading VTF hotspot data.

  • Don’t backslash-escape single quote characters.

  • Consult the various app IDs when looking for folders for searchpaths.

  • Deprecate UVAxis.rotate().

Version 2.6.1

  • Add srctools.math.PointsMap, which fuzzily matches vector keys.

  • Add Geometry.from_points(), creating a brush from a point cloud.

  • Add support for exporting the old FGD ‘report’ syntax (name(*type)).

  • Fix srctools.math.quickhull() not functioning, allow any vector as input.

  • Suppress the custom FGD editor-only flag if custom syntax is disabled.

  • Support various shader parameters added by Strata Source.

  • Properly implement detail prop packing logic, only pack sprites/models that are used by the BSP.

  • Add srctools.types, which contains common types and classes.

  • Switch type hints for all functions taking files to more precise protocols.

  • Add source tracking for packed files, allows logging the cause for each file.

  • Don’t resave package/soundscript caches for packlists if not modified.

  • Fix issue with locating Steam folders on non-Windows platforms.

Version 2.6.0

  • Rewrite FGD ‘helper’ parsing to more closely match the actual parser.

    • Spaces between arguments, not the commas are used to separate them. For most helpers commas are meaningless.

    • Make it clear that srctools.fgd.UnknownHelper should not be relied on - expect proper implementation to be added in future versions.

    • RGB colours now are 0-255 integers, not floats.

    • Helpers now all support tags, except for some extension helpers.

    • Deprecate bbox() helper, this doesn’t actually exist.

    • Backward-incompatible change - renamed HelperExtAppliesTo.tag to .applies.

  • Add srctools.geometry, which implements clipping and carving brushes.

  • Add extension editor (-only) flag to FGD keyvalue definitions.

  • Issue #38: Preserve entity/node/brush/etc IDs when parsing VMFs and BSP entities.

  • Treat ogg files as valid sounds in various places.

  • Consistently raise TypeError if invalid types are sent to a Tokenizer.

  • Properly add base_plat_train class resource function and fix item_teamflag.

  • BEE Issue #4299: Fix sprites and decals not being detected properly for packing.

  • Added periodic_callback option to Tokenizer, and allow that to be passed through Keyvalues.parse() and FileSystem.read_kv1().

  • Fix BSP.static_prop_models() breaking if props were already parsed.

  • Make toplevel aliases like srctools.VPK lazy import.

  • Add support for detecting sounds out of choreo scenes when packing.

Version 2.5.0

  • Drop support for Python 3.8.

  • Switch to Meson for building the package.

  • Issue #35: Only use character escapes in FGD custom syntax mode. The original parser only allows \n.

  • Add Token.PAREN_OPEN/PAREN_CLOSE, enabled by Tokenizer.string_parens.

  • Avoid escaping / and ?, these are unambiguous. BSPs also allow \n in values again.

  • Add multiline parameter to escape_text(), to allow preserving \n.

  • Add ValueTypes.EXT_SOUNDSCAPE.

  • Support exporting FGDs with unevaulated string bases.

  • Add suppport for reading non-directory VPK files, where contents are all in one file.

  • FGDs may optionally permit unknown value types to be parsed/exported in string form.

  • Fix some options being incorrectly handled in Strata game mounts definitions.

  • Allow entities to delete multiple keyvalues at once.

  • Add support for |appid_XXX| syntax in gameinfo.txt files.

  • Fix silent buttons trying to pack invalid Buttons.snd0 soundscripts.

  • Handle entities being added/removed during iteration of VMF.search().

  • Share common strings in the engine database to save some space.

  • Fix saving the PHYSCOLLIDE BSP lump.

  • In log files, increase size limits for ExceptionGroup tracebacks.

  • Add srctools.sndscript.SoundChars, allowing easier parsing of sound characters.

  • Add srctools.vtf.ImageFormats.is_transparent.

  • Add srctools.dmx.Element.get_wrap(), allowing handling defaults more conveniently.

  • Make EntityDef.kv, .inp and .out views settable, improve behaviour.

Version 2.4.1

  • Add srctools.steam, written by @Thenderek0. This allows locating Steam games based on their app ID. Support was also added for parsing Strata mount definitions in gameinfo.txt.

  • Add header_only option for VTF.read(), allowing reading only metadata if the image is not required.

  • Fix casing not being preserved for names of FGD keyvalues during parsing.

  • Fix PackList.write_soundscript_manifest(), write_particles_manifest() and write_manifest() trying to write to a closed file.

  • Handle string/int/float subclasses being assigned to VMF keys.

  • Add single_block argument to Keyvalues.parse(), allowing parsing blocks in the middle of a document.

  • Allow disabling the “spawnflag labelling” FGD feature.

  • srctools.logger log files will now always be written as UTF-8.

  • Add a custom_syntax option to FGD.export(), disabling export of custom syntax. Resources can now be exported.

  • Correctly produce an error if a FGD entity definition is missing its closing bracket.

  • Escape all characters utlbuffer.cpp does - \n, \t, \v, \b, \r, \f, \a, \, ?, ', ".

  • Unconditionally enable support for escaping characters in DMX Keyvalues2, since Valve’s parser can handle it. Binary formats never needed escaping.

  • Correctly look up types for conditional shader parameters (ldr?$bumpmap).

  • Parse FGDs correctly which have multiline strings with the plus on the second line.

Version 2.4.0

  • Added srctools.choreo, for parsing choreographed scenes.

  • Allow passing FrozenVec to VMF.make_prism()/make_hollow().

  • Fix bare strings on the end of CRLF lines eating the \r.

  • Escape characters like " when exporting VMFs and BSPs. This isn’t supported by regular Source, but can be added by other branches.

  • Added Keyvalues.line_num, to allow reporting the source location in exceptions.

  • Keyvalues.export() is now deprecated, use serialise() instead.

  • Allow passing VMF settings via keyword arguments - the map_info dictionary parameter is now deprecated.

  • Allow directly passing enums to set VMF keyvalues and fixups, if the value is itself a valid value.

  • Parse Strata Source’s other VMF additions - viewport configuration, brush face vertices and instance visibility.

  • Add Tokenizer.plus_operator, allowing + to be parsed as an operator for FGDs but still be valid inside bare strings elsewhere. These are common in gameinfo.txt.

  • Add Solid.is_cordon to replace cordon_solid, better representing its boolean nature.

  • Issue #29: Fix 0x03 characters causing an early EOF in the tokeniser.

  • Preserve passed in key casing in find_key()/find_block()’s return values.

Version 2.3.17

  • Added Keyvalues.serialise(), a replacement for export().

  • Fix + and = being parsed as part of a bare string if not the first character.

  • Fix keyvalue-type snippets causing a parse error for code coming after them.

  • Include filename/line number in missing snippet errors.

Version 2.3.16

  • Fix entity keyvalues being lowercased when parsed from files.

  • Add “snippets” to FGD parsing, allowing reuse of descriptions and other small pieces of data.

  • Allow VMTs to use /* */ comments.

  • Issue #24: Fix incorrect matrix.inverse() being calculated. PR by @Ozxybox.

  • Allow omitting file/line number parameters for TokenSyntaxError.

  • Allow passing PrismFace to VMF.add_brush().

  • Parse Strata Source’s VMF displacement data.

  • Remove negative zeros when formatting vector and angle values.

  • Expand Angle/Matrix.from_basis() to pick the orientation if less than 2 vectors are provided.

  • Add vmf.Side.from_normal(), which generates a VMF face pointing in an arbitary direction.

  • Add vmf.Solid.point_inside(), which checks if a point is inside or outside a brush.

Version 2.3.15

  • HammerAddons Issue #237: Ensure FGD model helpers will override each other.

  • Issue #20: Fix VTF.compute_mipmaps() not working for cubemaps.

  • Correctly handle .vvd/.vtx etc files if packed as MODEL.

  • Improve performance of pure-Python VTF save/loading code.

  • Add Vec.clamped(), for applying min/max bounds to a vector.

  • Fix Entity.make_unique() renaming entities with numeric suffixes which were already unique.

Version 2.3.14

  • Drop support for Python 3.7.

  • Fix VMT parsing not braces on the same line as the block name, like Proxies {.

  • Add Cythonised versions of conv_int(), conv_float() and conv_bool().

  • Added a repr() for srctools.vmf.Entity.

  • Automatically clean up up empty sets when removing entities from VMF.by_class and .by_target.

  • Fixed saving/loading issues with a number of VTF formats.

Version 2.3.13

Version 2.3.12

  • Handle the special $gender “variable” in WAV filenames.

  • Add prop_door_rotating class resource function.

  • Remove weapon_script class resource function, instead use a direct resource in the FGD.

  • Use typing_extensions.deprecated() to mark functions and methods which should not be used.

Version 2.3.11

  • Include the docs and tests in the source distribution.

  • Add support for detecting and packing weapon scripts.

  • Make custom model gibs inherit skinset when packing.

  • Add srctools.bsp.BModel.clear_physics(), to delete physics data for a brush model.

  • Add srctools.keyvalues.LeafKeyvalueError, raised when block-only operations are attempted on leaf keyvalues. This improves the messages raised and makes them consistent.

  • Fix srctools.vtf.Frame indexing behaviour. It would access totally incorrect pixels.

  • Correctly read/write L4D2’s BSP format.

Version 2.3.10

  • Fix srctools.vtf.Frame.copy_from() not clearing cached unparsed file data. If the VTF was parsed from a file, this could case changes to be overwritten with the original data.

  • Add srctools.vtf.Frame.fill(), for filling a frame with a constant colour.

  • PR #17: Add support for Strata’s non-uniform static prop scaling (by @Ozxybox).

  • Correctly handle non-float numeric values being passed to various srctools.math operations.

  • Compute the total vertex count for parsed models.

Version 2.3.9

Version 2.3.8

  • Fix srctools.logger discarding trio.MultiError (or its backport) if it bubbles up to the toplevel.

  • Tweak VMF localise() and translate() type hints to allow FrozenVec as the origin.

  • Make movement and rotation of displacements work correctly.

  • Handle pitch keyvalues correctly when instancing, only rotating if it is a specific type.

  • Changed srctools.instancing.collapse_one() to use the entclass database directly, deprecating the fgd parameter as a result.

  • Fix BSP.surfedges incorrectly using edge 0, which may cause a single invisible triangle in maps.

Version 2.3.7

  • Removed some unusable constructor parameters from srctools.vmf.VMF, since they required passing in an object which requires the not-yet-constructed VMF as a parameter.

  • Renamed srctools.fgd.KeyValues to KVDef, so it is not confused with KV1 trees.

  • Replace on_error callback in srctools.logger.init_logging() with error, which now takes just an BaseException.

  • SurfaceProp has been rewritten to use attrs to simplify code.

  • Add srctools.run.send_engine_command(), which executes console commands in a running Source game.

  • Vec and FrozenVec no longer inherits from typing.SupportsRound, since typeshed updated the overloads for round() to permit zero-arg calls to return a non-int type.

  • Permit VMFs to accept frozen math classes directly as keyvalues.

  • Fix multiplying vectors and Vec.norm_mask() not producing FrozenVec.

  • Parse errors in BSP.ents are more informative and verbose.

  • Add an additional callback parameter to PackList.pack_into_zip() to finely control which files are packed.

  • Implement vector and angle stringification manually, to ensure .0 prefixes are always removed.

  • Use FrozenVec and FrozenAngle in the dmx module instead of namedtuple() subclasses.

  • Upgrade srctools.dmx.Time to a full class instead of a typing.NewType.

  • Fix packlist logic inadvertently discarding skinset keyvalue hints when packing models.

  • Change behaviour of DMX name and id attributes to match game logic. name is actually a regular attribute, but the uuid has a unique type and so can coexist with an attribute of the same name.

  • Add support for Black Mesa’s static prop format.

  • Support integer values for soundscript channels, instead of just CHAN_ constants.

  • Add a distinct exception (RootEscapeError) for when ../ paths go above the root of a filesystem.

Version 2.3.6

  • Add ability to specify resources used in entities to the FGD file, move internal class resource definitions to the Hammer Addons repository.

  • Added new srctools.fgd.EntityDef.get_resources() method, replacing fgd.entclass_*() methods.

  • When parsing VMF outputs, assume extraneous commas are part of the parameter.

  • Add FrozenVec, FrozenAngle and FrozenMatrix - immutable versions of the existing classes. This is a far better version of Vec_tuple, which is now deprecated.

  • Build Python 3.11 wheels.

  • Drop dependency on atomicwrites, it is no longer being maintained.

Version 2.3.5

  • Expand on documentation, build into explicit docs files.

  • Fix srctools.logging.LoggerAdapter.log() being invalid in Python 3.7.

  • Make srctools.fgd work when reloaded.

  • Remove blank srctools.choreo module.

  • Disable iterating on srctools.math.Matrix, this is not useful.

  • Add iterable parameter to srctools.dmx.Attribute.array(), for constructing arrays with values.

  • Fix DMX bool to float conversions mistakenly returning int instead.

  • Remove useless header_len attribute from srctools.vpk.VPK.

  • Rename srctools.property_parser.Property to srctools.keyvalues.Keyvalues, as well as NoKeyError and KeyValError.

  • Allow parsing srctools.fgd.IODef types which normally are not allowed for I/O. This will be substituted when exporting.

  • Use __class__.__name__ in reprs, to better support subclasses.

  • Issue #14: Disable some size checks on LZMA decompression, so more TF2 maps can be parsed.

Version 2.3.4

  • Add public submodules to __all__.

  • Disable escapes when parsing gameinfo files.

  • Add unprefixed vtx files to srctools.mdl.MDL_EXTS.

  • Skip empty folder/extension dicts when writing VPK files.

  • Clean up VPK fileinfo dicts when deleting files.

  • Default srctools.fgd.IODef to srctools.fgd.ValueTypes.VOID.

  • Sort tags when exporting FGDs, to make it determinstic.

Version 2.3.3

  • Writing out soundscript/particle cache can be non-atomic.

  • Vendor code from deprecated chunk.Chunk standard library class.

  • Fix bad use of builtin generics.

Version 2.3.2

Version 2.3.1

Version 2.3.0

  • Postcompiler code has been moved to HammerAddons.

  • Fix raw sound filenames not stripping special characters from the start when packing.

  • Allow srctools.dmx.Color to omit alpha when parsed from strings, and roound/clamp values.

  • Handle INFRA’s altered srctools.bsp.Primitive lump.

  • Read soundscripts and breakable chunk files with code page 1252.

  • Handle TF2’s LZMA compressed lumps.

  • Detect various alternate versions of srctools.bsp.StaticProp lumps, and parse them.

  • srctools.vmf.Entity now directly implements collections.abc.MutableMapping. Direct access to the Entity.keys dict is deprecated.

  • Correctly handle proxy blocks in Material patch shaders.

  • DMX stub and null elements use an immutable subclass, instead of having elements be None-able.

  • Disallow entities to have a blank classname.

  • Elide long arrays in element reprs.

  • Add some additional logs when finding propcombine models fails.

  • Clean up srctools.Property.build() API.

  • Make error messages more clear when Tokenizer.error() is used directly with a Token.

  • Include potential variables in KeyError from srctools.vmf.EntityFixup.substitute().

  • Remove support for deprecated imghdr module.

  • Upgrade plugin finding logic to ensure each source is mounted under a persistent ID.

  • Add missing srctools.bsp.Face.dynamic_shadows.

  • Deprecate srctools.AtomicWriter, use the atomicwrites module.

  • srctools._class_resources is now only imported when required.

  • Use Cython when building, instead of including sources.

  • srctools.vmf.Entity.fixup will instantiate the EntityFixup object only when actually required.

Version 2.2.5

Version 2.2.4

Version 2.2.3

  • Fix use of builtin generics.

Version 2.2.2

  • Document some known particle manifest paths.

  • Handle double-spacing in animation particle options.

  • Improve type hints in srctools.smd.

Version 2.2.1

  • Missing particles is now an warning, not an error.

  • Particles are now case-insensitive.

  • py:meth:srctools.vmf.EntityFixup.keys(), values() and items() are now full mapping views.

  • Fix incompatibility with some Python versions.

Version 2.2.0

  • Make srctools.compiler.mdl_compiler generic, to allow typechecking results.

  • Add srctools.particles.

  • DMX attributes may now be copied using the copy module, and also tested for equality.

  • srctools.sndscript.Sound now lazily creates operator stack keyvalue objects.

  • srctools.packlist.PackList now can pack particle systems, and generate particle manifests.

  • Animation events which spawn particles are also detected.

Version 2.1.0