Add Half-Life !cur_* current contents support

Implements support for Half-Life's !cur_* textures (current water directions) in vmt-bsp, including new CONTENTS_CURRENT_* values and content flag handling. Updates documentation, changelog, and adds a test map and textures for validation. Also introduces a case-insensitive string prefix utility.

Author: themuffinator

BUILDING.md

@@ -77,11 +77,12 @@ cmake .. -DCMAKE_BUILD_TYPE=Release
 cmake --build . --parallel
 ```
 
-### macOS 🍎
+### macOS (10.15+) 🍎
 
 ```bash
 # Install dependencies via Homebrew
-brew install cmake embree tbb
+brew install cmake embree tbb qt@6
+# Qt6 is only needed for vmt-lightpreview
 
 # Clone and build
 git clone --recursive https://github.com/themuffinator/VibeyMapTools.git

CHANGELOG.md

@@ -10,6 +10,9 @@ For the detailed changelog with full technical details, see the [docs/changelog.
 
 This release continues the VibeyMapTools fork with rebranding and modernization.
 
+### Features
+- **vmt-bsp**: Half-Life `!cur_*` current contents support (`CONTENTS_CURRENT_*`)
+
 ### Changed
 - Project rebranded from ericw-tools to VibeyMapTools (VMT)
 - All executables now prefixed with `vmt-` for clarity

README.md

@@ -111,18 +111,21 @@ vmt-light -gpu -extra4 -bounce 2 -denoise mymap.bsp
 
 ## 🧪 Building from Source
 
-```bash
-git clone --recursive https://github.com/themuffinator/VibeyMapTools.git
-cd VibeyMapTools && cmake -B build -DCMAKE_BUILD_TYPE=Release
-cmake --build build
-```
-
-<details>
-<summary><b>Requirements</b></summary>
-
-- CMake 3.14+
-- C++20 compiler (MSVC 2019+, GCC 9+, Clang 10+)
-- Embree 4.x + oneTBB (required for `vmt-light`)
+```bash
+git clone --recursive https://github.com/themuffinator/VibeyMapTools.git
+cd VibeyMapTools && cmake -B build -DCMAKE_BUILD_TYPE=Release
+cmake --build build
+```
+
+macOS 10.15+ prep: `brew install cmake embree tbb qt@6` (Qt6 only needed for `vmt-lightpreview`)
+
+<details>
+<summary><b>Requirements</b></summary>
+
+- CMake 3.14+
+- C++20 compiler (MSVC 2019+, GCC 9+, Clang 10+)
+- macOS 10.15+ (Catalina) recommended for Apple builds
+- Embree 4.x + oneTBB (required for `vmt-light`)
 
 **Optional extras:**
 - Qt6 (for `vmt-lightpreview`)

docs/qbsp.rst

@@ -630,6 +630,36 @@ Special Surfaces
    original coordinates of the center of the "origin" brush before it was
    translated to 0 0 0.
 
+Half-Life BSP Specific
+^^^^^^^^^^^^^^^^^^^^^^
+
+.. texture:: !cur_0
+             !cur_90
+             !cur_180
+             !cur_270
+             !cur_up
+             !cur_dwn
+
+   These prefixes generate water with the given current direction:
+
+   ===================== =====
+   Content type          Value
+   ===================== =====
+   CONTENTS_CURRENT_0    -9
+   CONTENTS_CURRENT_90   -10
+   CONTENTS_CURRENT_180  -11
+   CONTENTS_CURRENT_270  -12
+   CONTENTS_CURRENT_UP   -13
+   CONTENTS_CURRENT_DOWN -14
+   ===================== =====
+
+   During the BSP process, they act like water with extra modifier flags.
+
+   .. note::
+
+      Different from the vanilla HL compiler, we don't generate faces between different ``CONTENTS_CURRENT_*`` textured
+      volumes.
+
 
 External Map Prefab Support
 ---------------------------

src/common/bspfile.cc

@@ -182,6 +182,8 @@ template<gameid_t ID>
 struct gamedef_q1_like_t : public gamedef_t
 {
 public:
+    bool allows_hl_contents = false;
+
     explicit gamedef_q1_like_t(const char *friendly_name = "quake", const char *base_dir = "ID1")
         : gamedef_t(friendly_name, base_dir)
     {
@@ -243,6 +245,20 @@ struct gamedef_q1_like_t : public gamedef_t
             case CONTENTS_WATER: return contentflags_t::make(EWT_VISCONTENTS_WATER);
             case CONTENTS_EMPTY: return contentflags_t::make(EWT_VISCONTENTS_EMPTY);
         }
+
+        if (allows_hl_contents) {
+            // clang-format off
+            switch (native) {
+                case HL_CONTENTS_CURRENT_0: return contentflags_t::make(EWT_VISCONTENTS_WATER | EWT_CFLAG_CURRENT_0);
+                case HL_CONTENTS_CURRENT_90: return contentflags_t::make(EWT_VISCONTENTS_WATER | EWT_CFLAG_CURRENT_90);
+                case HL_CONTENTS_CURRENT_180: return contentflags_t::make(EWT_VISCONTENTS_WATER | EWT_CFLAG_CURRENT_180);
+                case HL_CONTENTS_CURRENT_270: return contentflags_t::make(EWT_VISCONTENTS_WATER | EWT_CFLAG_CURRENT_270);
+                case HL_CONTENTS_CURRENT_UP: return contentflags_t::make(EWT_VISCONTENTS_WATER | EWT_CFLAG_CURRENT_UP);
+                case HL_CONTENTS_CURRENT_DOWN: return contentflags_t::make(EWT_VISCONTENTS_WATER | EWT_CFLAG_CURRENT_DOWN);
+            }
+            // clang-format on
+        }
+
         throw std::invalid_argument(fmt::format("create_contents_from_native: unknown Q1 contents {}", native));
     }
 
@@ -265,6 +281,21 @@ struct gamedef_q1_like_t : public gamedef_t
         } else if (contents.flags & EWT_VISCONTENTS_SLIME) {
             return CONTENTS_SLIME;
         } else if (contents.flags & EWT_VISCONTENTS_WATER) {
+            if (allows_hl_contents) {
+                if (contents.flags & EWT_CFLAG_CURRENT_0)
+                    return HL_CONTENTS_CURRENT_0;
+                if (contents.flags & EWT_CFLAG_CURRENT_90)
+                    return HL_CONTENTS_CURRENT_90;
+                if (contents.flags & EWT_CFLAG_CURRENT_180)
+                    return HL_CONTENTS_CURRENT_180;
+                if (contents.flags & EWT_CFLAG_CURRENT_270)
+                    return HL_CONTENTS_CURRENT_270;
+                if (contents.flags & EWT_CFLAG_CURRENT_UP)
+                    return HL_CONTENTS_CURRENT_UP;
+                if (contents.flags & EWT_CFLAG_CURRENT_DOWN)
+                    return HL_CONTENTS_CURRENT_DOWN;
+            }
+
             return CONTENTS_WATER;
         } else if (contents.flags & EWT_VISCONTENTS_MIST) {
             throw std::invalid_argument("EWT_VISCONTENTS_MIST not representable in Q1");
@@ -328,6 +359,29 @@ struct gamedef_q1_like_t : public gamedef_t
                 liquid_flags = EWT_CFLAG_DETAIL | EWT_CFLAG_TRANSLUCENT;
             }
 
+            // HL water with current
+            if (allows_hl_contents) {
+                contents_int_t current_flag = 0;
+
+                if (string_istarts_with(texname, "!cur_0")) {
+                    current_flag = EWT_CFLAG_CURRENT_0;
+                } else if (string_istarts_with(texname, "!cur_90")) {
+                    current_flag = EWT_CFLAG_CURRENT_90;
+                } else if (string_istarts_with(texname, "!cur_180")) {
+                    current_flag = EWT_CFLAG_CURRENT_180;
+                } else if (string_istarts_with(texname, "!cur_270")) {
+                    current_flag = EWT_CFLAG_CURRENT_270;
+                } else if (string_istarts_with(texname, "!cur_up")) {
+                    current_flag = EWT_CFLAG_CURRENT_UP;
+                } else if (string_istarts_with(texname, "!cur_dwn")) {
+                    current_flag = EWT_CFLAG_CURRENT_DOWN;
+                }
+
+                if (current_flag) {
+                    return contentflags_t::make(EWT_VISCONTENTS_WATER | liquid_flags | current_flag);
+                }
+            }
+
             if (!Q_strncasecmp(texname.data() + 1, "lava", 4)) {
                 return contentflags_t::make(EWT_VISCONTENTS_LAVA | liquid_flags);
             } else if (!Q_strncasecmp(texname.data() + 1, "slime", 5)) {
@@ -466,6 +520,7 @@ struct gamedef_hl_t : public gamedef_q1_like_t<GAME_HALF_LIFE>
         : gamedef_q1_like_t("halflife", "VALVE")
     {
         has_rgb_lightmap = true;
+        allows_hl_contents = true;
     }
 
     std::span<const aabb3d> get_hull_sizes() const override

src/common/cmdlib.cc

@@ -685,6 +685,11 @@ std::string_view::const_iterator string_ifind(std::string_view haystack, std::st
         [](char a, char b) { return tolower(a) == tolower(b); });
 }
 
+bool string_istarts_with(std::string_view haystack, std::string_view needle)
+{
+    return string_ifind(haystack, needle) == haystack.begin();
+}
+
 bool string_icontains(std::string_view haystack, std::string_view needle)
 {
     return string_ifind(haystack, needle) != haystack.end();

src/include/common/bspfile_q1.hh

@@ -105,6 +105,13 @@ enum q1_contents_t : int32_t
     CONTENTS_MIN = CONTENTS_SKY
 };
 
+constexpr static int HL_CONTENTS_CURRENT_0 = -9;
+constexpr static int HL_CONTENTS_CURRENT_90 = -10;
+constexpr static int HL_CONTENTS_CURRENT_180 = -11;
+constexpr static int HL_CONTENTS_CURRENT_270 = -12;
+constexpr static int HL_CONTENTS_CURRENT_UP = -13;
+constexpr static int HL_CONTENTS_CURRENT_DOWN = -14;
+
 constexpr static int BSPXBRUSHES_CONTENTS_CLIP = -8;
 
 struct bsp29_dnode_t

src/include/common/cmdlib.hh

@@ -98,6 +98,8 @@ struct natural_case_insensitive_less
 
 std::string_view::const_iterator string_ifind(std::string_view haystack, std::string_view needle);
 bool string_icontains(std::string_view haystack, std::string_view needle);
+// case-insensitive, checks if `haystack` starts with `needle`
+bool string_istarts_with(std::string_view haystack, std::string_view needle);
 
 #include <chrono>