Merge pull request #22 from Project-Collapse-Studios/van-dev

Merge upstream changes

Author: TheEnderek0

.gitignore

@@ -64,8 +64,8 @@ __pycache__/
 *.blend1
 
 # These should never be committed.
-srctools_paths.vdf
-srctools_*_data.dmx
+hammeraddons_paths.vdf
+hammeraddons_*_data.dmx
 
 # This shouldn't be shipped, but it is useful to have to allow using studiomdl/vtex.
 hammer/gameinfo.txt
@@ -74,8 +74,9 @@ hammer/gameinfo.txt
 _version.py
 
 # Ignore config in the examples folder.
-examples/srctools.vdf
+examples/hammeraddons.vdf
 
 # Random extra things
 output.fgd
 build_for_testing.bat
+reports/

CHANGELOG.md

@@ -1,18 +1,83 @@
-# Version Dev
+# Version (dev)
 
-# Enhancements
+## New Features
+* Added `comp_movie_fitter`, which calculates UVs for `vgui_movie_display`.
+* Added `comp_multi_command`, which allows executing console commands in bulk more conveniently.
+
+## Enhancements
+* Upgraded config handling:
+  * Files have been renamed to `hammeraddons.vdf` etc, instead of `srctools`. Old names are still loaded.
+  * Config files will no longer be rewitten. Instead any changes will produce a new file, which
+    should be merged with any comments in the old one, then copied over.
+  * Plugin scripts can now register their own config options, in addition to builtin ones.
+  * Searchpaths 'nopack' option now allows wildcards for disabling locations in bulk.
+* Moved options specifying the behaviour of the current game branch to a dedicated file, 
+  so users only need to pick from presets.
+* Update internal Crowbar to version 0.75. This is used decompile models for propcombine.
+* Added 1/16 scale skybox mode for vactube system. You'll need to provide your own models or use prop scaling.
+* Added vactube curves 7-16. You'll need to provide your own models though.
+* `comp_entity_finder`s can now use `@names` for replace outputs, so they work in HL2.
+* Allow `<appid>` references to be used everywhere `|srctools_paths|` references can be used.
+* `env_tonemap_controller` options can be set by keyvalues, generating a `logic_auto` automatically.
+* Added rotation, scale, animation, and bodygroup keyvalues to `hammer_model`. Some of these require a custom Hammer fork (e.g. Hammer++) to be visible.
+* Added a 'version number' to all postcompiler entities. This allows backwards-incompatible changes to occur in the future.
+* Added `OnPressedPlayer`/`OnPressedCube` outputs to Portal 2 floor button entities, implemented by spawning a filter entity.
+
+## Bugfixes
+* Fix vactube objects appearing to rapidly move from end to start positions in some cases.
+* Fix an issue where vactube objects might have the wrong model, overlap each other, etc.
+* Improved handling of more complex `gameinfo.txt` files like Mapbase's.
+* Automatically remove old generated vactube animation models.
+* Fix an issue where prop ropes generated with slight angles on straight sections.
+* Fix prop ropes not reusing existing compiled versions.
+* Fix `trigger_vphysics_motion`/`trigger_wind` having `OnStartTouch` etc outputs, which they don't have.
+
+-----------------------
+
+# Version 2.6.0
+
+The postcompiler now requires Windows 8+.
+
+## New Features
+* Added `comp_vactube_sensor`, which allows detecting the presence of vactube objects.
+* Added `comp_piston_platform`, which generates the logic for Portal-style piston platforms.
+* Added option to `trigger_hurt` to create the logic for 'forgiving laserfields'.
+* Added `hammer_model` entity to allow placing reference models in Hammer that don't appear in-game.
+
+## Enhancements
+* Update to Mapbase 7.3.
 * A new "snippets" system allows FGD files to easily repeat descriptions and other small sections.
 * Add ability to randomise output delay to `comp_relay` and `comp_adv_output`.
-* Added `comp_vactube_sensor`, which allows detecting the presence of vactube objects.
 * Added a value mode option to `comp_kv_setter` and `comp_adv_output` to more clearly control which key is used.
 * Added textures for 4 rendertargets (camera, water reflection/refraction, full framebuffer). These give a nice preview in Hammer.
 * Added three keyvalues to `ambient_generic`, giving a more user friendly interface to the confusing spawnflags. This also allows them to be configured via fixup values easily.
+* Added line helpers to `env_microphone`, `scripted_sequence`, `path_track`, and `item_item_crate`.
+* Added Source 2013's `SetModelScale` input to all animating entities,
+* Added undocumented `ChangeLevelPostFade` input to `point_changelevel`.
+* Added Portal: Still Alive features (not currently included in releases, but can be built by including the `PSA` tag),
+* Added "singular" and "remove" modes to `comp_kv_setter`.
 * Allow `comp_entity_finder` to rotate the target in addition to teleporting.
+* `comp_kv_setter`s can now lookup the flags mask based on the name in the FGD.
 * Allow configuring various shadow/fast reflection options for vactube object ents.
 * Boolean keyvalues (yes/no) can now be set to `!$var`, to invert the value of the variable. 
+* Consistently seed the RNG for compiler entities, to produce consistency across compiles. 
+  Relevant entities now all have `seed` parameters to further adjust.
 * Propcombine will now preserve prop fade distances, by calculating a new distance which encloses the original fade spheres.
-* Warn if propcombine or packing was disabled via command line.
+* Propcombined models will try and use group names for the filename, if specified.
+* Warn in the log if propcombine or packing was disabled via command line, so this is easier to diagnose.
+* Add SFX to the Old Aperture cubedropper to simulate the new cube landing.
+* Multiple prop ropes with the same shape and configuration will now properly share models.
 * Add option to `comp_adv_output` to have it expand target searches itself.
+* Refer to the "Gravity Gun" in descriptions instead of physgun/physcannon.
+* Floor buttons with `solid=6` will automatically be fixed, since this unintentionally makes them non-solid.
+* The postcompiler will now detect and error if a loop of parents/filters is detected. These will just crash the game in a non-obvious manner.
+* Included a copy of the "Obsolete" sprite used for missing entities, for games that don't include it by default such as Portal 2.
+* Improved `game_text` keyvalue descriptions and added Mapbase's font keyvalue,
+* Updated the icon for `skybox_swapper`.
+* Removed `info_paint_sprayer` keyvalues which are set in some Valve maps, but don't actually exist.
+* Removed Hammer preview from Mapbase's `vgui_text_display` as it did not actually match the in-game appearance.
+* Removed `skybox_swapper` in Mapbase as it doesn't actually work.
+* Removed `playtest_manager` entity as it doesn't actually exist in-game.
 
 ## Bugfixes
 * Fix a compile failure if prop ropes were placed in a group with no connections.
@@ -21,6 +86,15 @@
 * Fix overlays not functioning with `material_modify_control` parent searching.
 * Make RunScriptCode \` handling occur after everything else.
 * #274, #277: Force required keyvalue casing for `light_environment`'s `SunSpreadAngle` and `lua_run`'s `Code` keys.
+* Fix hammer_notes text size/color parameters being missing for games before CS:GO.
+* Fix an issue with `func_instance_io_proxy` and `comp_` entities.
+* Fix mismatched numbering between `logic_random_outputs` KVs and inputs.
+* Fix `comp_kv_setter`/`comp_adv_output` position keyvalues not getting transformed by instances in Source 2013.
+* Fix `comp_adv_output` string keyvalues getting transformed as entity names.
+* Fix not being able to scale props with ctrl+scrollwheel in Hammer++.
+* Fix turret FOV preview being incorrect - it's 120 degrees, not 90.
+* Fix item entities not rotating their hitboxes in Hammer.
+* Fix typos in some movie filenames.
 
 
 --------------------

CREDITS.md

@@ -3,3 +3,4 @@
 - [ZPS: Supplemental Hammer Icons](http://www.necrotalesgames.com/tools/index.php) (some icons)
 - [ts2do's HL2 FGDs](http://halflife2.filefront.com/file/HalfLife_2_Upgraded_Base_FGDs;48139) (some more icons)
 - [Ficool2's FGD pack](https://tf2maps.net/downloads/ficool2s-overhauled-fgd-all-entities-documentated-icons.7209/) (several icons)
+- Ashanderite (comp\_multi\_command icon)

README.md

@@ -9,8 +9,9 @@
 
 ## Features
 
+* A "postcompiler" application which processes BSPs, allowing most of the new features.
 * Auto-packing - Automatically packs non-stock game files into the bsp. Filtered based on search paths in the included custom gameinfo and FGD database. Assets can also be packed manually with `comp_pack` entities.
-* Static prop combining - merges together adjacent props to allow them to be efficently drawn in batches. To use, specify studioMDL's path then place `comp_propcombnine_volume` or `comp_propcombine_set` entities.
+* Static prop combining - merges together adjacent props to allow them to be efficently drawn in batches. To use, specify studioMDL's path then place `comp_propcombine_volume` or `comp_propcombine_set` entities.
 * A [unified FGD database][unifiedfgd], allowing keyvalues to be shared among games, and accurately defining when features were added and removed.
 * Many more entity options, and an improved editor layout.
 * New sprites for almost all entities, both custom made and from a number of [other sources](#development).
@@ -24,29 +25,33 @@ Below are short explanations, see the "Help" display on the entity properties in
 | Entity                                             | Description                                                                                                                                                                  |
 |----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `comp_adv_output`                                  | Adds a single output to another entity, while allowing instance renaming or `$fixups` to apply to only certain parts.                                                        |
-| `comp_flicker`                                     | Fires on/off and skin inputs repeatedly to simulate a flicker-on effect.                                                                                                     |
 | `comp_case`                                        | Version of `logic_case` which is optimised away by the compiler.                                                                                                             |
 | `comp_choreo_sceneset`                             | Chains a set of choreographed scenes together.                                                                                                                               |
 | `comp_entity_finder`                               | Finds the closest entity of a given type, then applies various transformations. Outputs from this entity will be moved to the found entity.                                  |
 | `comp_entity_mover`                                | Shift an entity by a given amount. This is useful to place entities into the void, for example.                                                                              |
+| `comp_flicker`                                     | Fires on/off and skin inputs repeatedly to simulate a flicker-on or off effect.                                                                                              |
 | `comp_kv_setter`                                   | Sets a keyvalue on an entity to a new value. This is useful to compute spawnflags, or to adjust keyvalues when the target entity's options can't be set to a fixup variable. |
+| `comp_multi_command`                               | Executes console commands in bulk by generating appropriate I/O inputs.                                                                                                      |
 | `comp_numeric_transition`                          | When triggered, animates a keyvalue/input over time with various options.                                                                                                    |
 | `comp_pack`                                        | Explicitly identify resources to pack into the map, in addition to automatic detection.                                                                                      |
 | `comp_pack_rename`                                 | Pack a file into the BSP, under a different name than it starts with.                                                                                                        |
 | `comp_pack_replace_soundscript`                    | Replace a soundscript with a different one.                                                                                                                                  |
+| `comp_piston_platform`                             | Generates the appropriate logic to sequence a Portal-style piston platform.                                                                                                  |
 | `comp_player_input_helper`                         | Fake entity that allows Hammer to autocomplete inputs fired at the special `!player` name (and other similar ones).                                                          |
 | `comp_precache_model`                              | Force a specific model to load, for runtime switching. Duplicates will be removed.                                                                                           |
 | `comp_precache_sound`                              | Force a specific sound to load, for runtime switching. Duplicates will be removed. More keyvalues can be added.                                                              |
 | `comp_prop_cable`/`comp_prop_rope`                 | Generates 3D cables using a static prop.                                                                                                                                     |
 | `comp_prop_cable_dynamic`/`comp_prop_rope_dynamic` | Modifies the above to generate a dynamic prop, instead.                                                                                                                      |
+| `comp_prop_rope_bunting`                           | Adds additional props or geometry along the 3D cables.                                                                                                                       |
 | `comp_propcombine_set`/`comp_propcombine_volume`   | Specifies a group of props that will be combined together, so they more efficiently render.                                                                                  |
 | `comp_relay`                                       | Simplified version of `logic_relay` which is able to be optimised away by the compiler.                                                                                      |
 | `comp_scriptvar_setter`                            | Assigns data or a group of data to a variable in an entity's VScript scope on spawn.                                                                                         |
 | `comp_sequential_call`                             | Finds a sequence of entities (by distance or numeric suffix), then fires inputs delayed in order.                                                                            |
 | `comp_vactube_end`                                 | Marks the end point of a vactube. Objects reaching here will be cleaned up.                                                                                                  |
 | `comp_vactube_junction`                            | Marks a junction in a vactube, where they're forced to change direction. Scanner models near straight nodes will be detected automatically.                                  |
-| `comp_vactube_spline`                              | Generates a dynamic vactube model following a set of points.                                                                                                                 |
 | `comp_vactube_object`                              | Registers objects that can appear in the tubing.                                                                                                                             |
+| `comp_vactube_sensor`                              | Triggers outputs when a vactube object passes close by.                                                                                                                      |
+| `comp_vactube_spline`                              | Generates a dynamic vactube model following a set of points.                                                                                                                 |
 | `comp_vactube_start`                               | Marks the start point of a vactube. This is where they spawn.                                                                                                                |
 
 
@@ -55,9 +60,7 @@ Below are short explanations, see the "Help" display on the entity properties in
 * Follow [this guide][installationwiki].
 * If using BEEMOD2.4, change Hammer -> Options -> Build Programs to use `vrad_original.exe`.
 
-
-
-## Development
+## Credits
 
 * Mapbase's FGDs have been imported as a submodule.
 * Some entity sprites are taken from: 
@@ -66,6 +69,43 @@ Below are short explanations, see the "Help" display on the entity properties in
   * [ts2do's HL FGDs][ts2do]
 * Parts of [Allison's Portal 1 FGD edits][p1fgd] have been integrated into the fgds.
 
+## Development
+
+### Installing dependencies
+The code requires Python 3.13, and is mainly written on Windows (since that's where Hammer works).
+But it should work fine on Linux. To get dependencies:
+
+1. You'll likely want a virtual environment to keep the packages isolated - see Python's `venv` module.
+   Running `python -m venv some_folder/` will create one, then you can run the
+   `activate` script inside there to enable the environment.
+2. Run `python -m pip install -r requirements.txt` to install neceessary modules.
+3. Optionally `python -m pip install -r test-requirements.txt` to run some test code.
+
+### Building FGDs
+FGDs are stored as individual files, in a [unified][unifiedfgd] format tagged with games. This
+allows appropriate FGDs to be assembled for any Source game. To build an FGD for HL2 (for example):
+
+```shell
+cd src
+python hammeraddons/unify_fgd.py export hl2 srctools -o "build/hl2.fgd"
+```
+
+Consult the lists at the start of the script for available tags. The first is the game/mod, any
+additional ones are "features" like `srctools` for postcompiler features, or `propper` for those ents.
+
+### Building from source
+
+Many features require the postcompiler, which is a Python application. Releases have a compiled
+build, but for development purposes it may be useful to build locally or run from source. This also
+creates the `gen_choreo` utility.
+
+Cd into `src/`, then run  `python -m PyInstaller ../postcompiler.spec` to freeze the application.
+Optionally pass `--workpath XXX` and `--distpath XXX` to specify a temp folder and the destination
+respectively.
+
+The compiler can also be run from source by executing `hammeraddons/postcompiler.py`, 
+with `src/` in `PYTHONPATH`.
+
 [releases]: https://github.com/TeamSpen210/HammerAddons/releases
 [installationwiki]: https://github.com/TeamSpen210/HammerAddons/wiki/Installation
 [unifiedfgd]: https://github.com/TeamSpen210/HammerAddons/wiki/Unified-FGD