Add HUD, selection tools, and auto-reload to vmt-preview

Introduces a HUD overlay with portal/leaf counts, selection info, and lightgrid sample stats in vmt-preview. Adds selection tools (copy face/texture info, focus camera, solo texture), selection ray rendering toggle, and auto-reload for portal/leak visualizations and BSP outputs. Updates documentation, changelog, and build instructions for new features and Qt6 setup.

Author: themuffinator

.github/workflows/release.yml

@@ -3,6 +3,8 @@ name: Release
 on:
   push:
     tags: ['v*']
+  release:
+    types: [published]
   workflow_dispatch:
     inputs:
       tag:
@@ -28,6 +30,9 @@ jobs:
         shell: bash
         run: |
           TAG="${{ inputs.tag }}"
+          if [ -z "$TAG" ]; then
+            TAG="${{ github.event.release.tag_name }}"
+          fi
           if [ -z "$TAG" ]; then
             TAG="${GITHUB_REF_NAME}"
           fi
@@ -152,7 +157,7 @@ jobs:
         with:
           tag_name: ${{ needs.version.outputs.tag }}
           name: VibeyMapTools ${{ needs.version.outputs.version }}
-          draft: true
+          draft: ${{ github.event_name != 'release' }}
           prerelease: ${{ contains(needs.version.outputs.tag, '-') }}
           generate_release_notes: true
           files: |

BUILDING.md

@@ -111,6 +111,37 @@ If CMake cannot find them, pass the package config paths:
 cmake .. -Dembree_DIR=/path/to/embree/lib/cmake/embree-4.x -DTBB_DIR=/path/to/tbb/lib/cmake/tbb
 ```
 
+### Qt6 (vmt-preview GUI) 🪟
+
+`vmt-preview` is built when Qt6 is available and `ENABLE_LIGHTPREVIEW=ON`.
+
+**Required components**
+- Qt6 Core, Gui, Widgets, OpenGL, OpenGLWidgets
+
+**Windows (Qt Online Installer)**
+1) Install Qt 6.x (MSVC build) with the components above.
+2) Point CMake at the Qt install:
+
+```powershell
+cmake -B build -DENABLE_LIGHTPREVIEW=ON -DCMAKE_PREFIX_PATH="C:\Qt\6.6.2\msvc2019_64"
+```
+
+**Linux (Debian/Ubuntu)**
+```bash
+sudo apt install qt6-base-dev qt6-base-dev-tools libgl1-mesa-dev
+cmake -B build -DENABLE_LIGHTPREVIEW=ON
+```
+
+**macOS (Homebrew)**
+```bash
+brew install qt@6
+cmake -B build -DENABLE_LIGHTPREVIEW=ON -DCMAKE_PREFIX_PATH="$(brew --prefix qt@6)"
+```
+
+**Verification**
+In CMake output, ensure Qt6 is detected and `ENABLE_LIGHTPREVIEW` remains ON. The
+`vmt-preview` binary should appear in `build/` after a successful build.
+
 ### NVIDIA OptiX (GPU Raytracing) ?
 
 This enables the `-gpu` path in `vmt-light` (OptiX-backed raytracing). If OptiX isn't found, `-gpu`

CHANGELOG.md

@@ -6,6 +6,19 @@ For the detailed changelog with full technical details, see the [docs/changelog.
 
 ---
 
+## [Unreleased]
+
+### Features
+- **vmt-preview**: HUD overlay with portal/leaf counts, selection info, and lightgrid sample stats
+- **vmt-preview**: Selection tools (copy face/texture info, focus camera on face/leaf, solo selected texture)
+- **vmt-preview**: Auto-reload portal/leak visualizations (.prt/.pts/.lin) and BSP outputs for .map sessions
+- **vmt-preview**: Optional selection ray rendering toggle
+
+### Bug Fixes
+- **vmt-preview**: Fix portal overlay color uniforms being sent to the wrong shader
+
+---
+
 ## [2.1.0] - 2026-01-01
 
 This release continues the VibeyMapTools fork with rebranding and modernization.

CMakeLists.txt

@@ -169,11 +169,16 @@ add_subdirectory(src/maputil)
 option(DISABLE_TESTS "Disables Tests" OFF)
 option(DISABLE_DOCS "Disables Docs" OFF)
 option(ENABLE_LIGHTPREVIEW "Enable light preview tool" ON)
+option(ENABLE_BUILDGUI "Enable build GUI tool" ON)
 
 if (ENABLE_LIGHTPREVIEW)
 	add_subdirectory(src/lightpreview)
 endif ()
 
+if (ENABLE_BUILDGUI)
+	add_subdirectory(src/buildgui)
+endif ()
+
 if(NOT DISABLE_TESTS)
 	enable_testing()
 	# just creates testmaps.hh with absolute path to the testmaps source directory.

CONTRIBUTING.md

@@ -2,6 +2,8 @@
 
 Thank you for your interest in contributing to VibeyMapTools! This document provides guidelines for contributing.
 
+Coming from ericw-tools? The flow is the same, but release automation lives in GitHub Actions and binaries are prefixed with `vmt-`.
+
 ## Getting Started
 
 1. Fork the repository
@@ -62,6 +64,29 @@ Example: `feat: add support for PBR lightmaps`
 - Open a Discussion on GitHub
 - Check the [WIKI.md](WIKI.md) for documentation
 
+## Release Process (Maintainers)
+
+This is for contributors with release privileges.
+
+1. Update `VERSION` with the next release number (e.g., `2.1.1`).
+2. Update `CHANGELOG.md` and `docs/changelog.rst` with user-visible changes.
+3. Build and test locally:
+   - `cmake -B build -DCMAKE_BUILD_TYPE=Release`
+   - `cmake --build build --config Release`
+   - `ctest --test-dir build --output-on-failure --build-config Release`
+4. Commit the changes:
+   - `git add VERSION CHANGELOG.md docs/changelog.rst`
+   - `git commit -m "chore: release vX.Y.Z"`
+5. Tag the release and push:
+   - `git tag -a vX.Y.Z -m "Release vX.Y.Z"`
+   - `git push origin main`
+   - `git push origin vX.Y.Z`
+
+GitHub Actions will build packages and attach them to the release. You can create a GitHub Release
+manually (Publish Release) or rely on the workflow to draft it on tag push.
+
+For more detailed steps and packaging notes, see the release section in [WIKI.md](WIKI.md).
+
 ## License
 
 By contributing, you agree that your contributions will be licensed under the GPLv3 license.

WIKI.md

@@ -146,6 +146,43 @@ vmt-light -lightgrid -world_units_per_luxel 8 mymap.bsp
 
 ---
 
+## 🚀 Release + Packaging (Maintainers)
+
+For contributors with release privileges, here is the end-to-end flow.
+
+**1) Update version + notes**
+- Edit `VERSION` with the next release number (example: `2.1.1`).
+- Update `CHANGELOG.md` and `docs/changelog.rst`.
+
+**2) Build + test locally**
+```bash
+cmake -B build -DCMAKE_BUILD_TYPE=Release
+cmake --build build --config Release
+ctest --test-dir build --output-on-failure --build-config Release
+```
+
+**3) Create a local package (optional but recommended)**
+```bash
+cmake --build build --target package --config Release
+```
+
+**4) Commit + tag**
+```bash
+git add VERSION CHANGELOG.md docs/changelog.rst
+git commit -m "chore: release vX.Y.Z"
+git tag -a vX.Y.Z -m "Release vX.Y.Z"
+git push origin main
+git push origin vX.Y.Z
+```
+
+**5) Publish a GitHub Release**
+- Either publish a release on GitHub (using the tag), or
+- Let the tag push create a draft release via GitHub Actions.
+
+The release workflow builds packages on Windows/macOS/Linux and attaches them to the release.
+
+---
+
 ## 🛰️ Additional Resources
 
 - **Issue Tracker**: Report bugs and request features on GitHub

docs/lightpreview.rst

@@ -14,6 +14,8 @@ and :doc:`light` with a 3D viewport for visualizing the output in real-time.
 .. note::
 
    This tool is experimental and primarily packaged in the Windows build.
+   Coming from ericw-tools? ``vmt-preview`` is the modernized successor to the
+   classic lightpreview flow, with extra visibility and selection tooling.
 
 Features
 --------
@@ -26,6 +28,18 @@ Features
 * Lightgrid visualization (for Q2 remaster maps)
 * Support for .lit file loading
 
+Previews
+--------
+
+The preview panel now covers much more than lightmaps. Enjoy a broader debugging
+toolkit with quick visual feedback. 🎛️✨
+
+* 🧭 **HUD overlay** with faces, leafs, portal counts, vis state, and selection info
+* 🧱 **Portals and leaks**: auto-watch .prt/.pts/.lin and refresh as you iterate
+* 🧲 **Selection ray** to confirm hit tests when clicking geometry
+* 🎯 **Selection tools**: copy face + texture info, focus camera on face/leaf, solo a texture
+* 🌈 **Lightgrid samples** listed in HUD when BSPX lightgrid data is present
+
 Controls
 --------
 
@@ -40,11 +54,13 @@ Movement
 View Modes
 ~~~~~~~~~~
 
-* :kbd:`Alt-1` — Lightmapped (default)
-* :kbd:`Alt-2` — Lightmap Only
-* :kbd:`Alt-3` — Fullbright
-* :kbd:`Alt-4` — Normals
-* :kbd:`Alt-5` — Flat shading
+* :kbd:`Alt-1` - Lightmapped (default)
+* :kbd:`Alt-2` - Lightmap Only
+* :kbd:`Alt-3` - Fullbright
+* :kbd:`Alt-4` - Normals
+* :kbd:`Alt-5` - Flat shading
+* :kbd:`H` - Toggle HUD overlay (viewport focused)
+* :kbd:`T` - Toggle solo selected texture
 
 
 Usage
@@ -57,6 +73,32 @@ Usage
 The tool will automatically compile the map and display it in the viewport.
 Changes to lighting parameters can be previewed interactively.
 
+Qt6 Setup
+---------
+
+`vmt-preview` builds when Qt6 is installed and ``ENABLE_LIGHTPREVIEW=ON``.
+Required Qt6 components: Core, Gui, Widgets, OpenGL, OpenGLWidgets.
+
+Example (Windows, Qt Online Installer):
+
+.. code-block:: powershell
+
+   cmake -B build -DENABLE_LIGHTPREVIEW=ON -DCMAKE_PREFIX_PATH="C:\Qt\6.6.2\msvc2019_64"
+
+Example (macOS, Homebrew):
+
+.. code-block:: bash
+
+   brew install qt@6
+   cmake -B build -DENABLE_LIGHTPREVIEW=ON -DCMAKE_PREFIX_PATH="$(brew --prefix qt@6)"
+
+Example (Linux, Debian/Ubuntu):
+
+.. code-block:: bash
+
+   sudo apt install qt6-base-dev qt6-base-dev-tools libgl1-mesa-dev
+   cmake -B build -DENABLE_LIGHTPREVIEW=ON
+
 
 See Also
 --------
@@ -89,4 +131,4 @@ License GPLv3: GNU GPL version 3 or later
 https://gnu.org/licenses/gpl-3.0.html
 
 This is free software: you are free to change and redistribute it.
-There is NO WARRANTY, to the extent permitted by law.
+There is NO WARRANTY, to the extent permitted by law.