Merge branch 'dev'

Author: DavidJCobb

native/src/ReachVariantTool/ReachVariantTool.vcxproj

@@ -74,7 +74,7 @@
       <BuildStlModules>false</BuildStlModules>
     </ClCompile>
     <Link>
-      <SubSystem>Windows</SubSystem>
+      <SubSystem>Console</SubSystem>
       <GenerateDebugInformation>true</GenerateDebugInformation>
     </Link>
     <QtUic>
@@ -94,14 +94,15 @@
       <EnableModules>false</EnableModules>
     </ClCompile>
     <Link>
-      <SubSystem>Windows</SubSystem>
+      <SubSystem>Console</SubSystem>
       <GenerateDebugInformation>false</GenerateDebugInformation>
     </Link>
     <QtUic>
       <QtUicDir>$(IntDir)uic\%(RelativeDir)</QtUicDir>
     </QtUic>
   </ItemDefinitionGroup>
   <ItemGroup>
+    <ClCompile Include="cli.cpp" />
     <ClCompile Include="editor_state\ReachStringCentralModel.cpp" />
     <ClCompile Include="formats\block.cpp" />
     <ClCompile Include="formats\content_author.cpp" />
@@ -174,6 +175,7 @@
     <ClCompile Include="game_variants\io_process.cpp" />
     <ClCompile Include="game_variants\types\firefight.cpp" />
     <ClCompile Include="game_variants\types\multiplayer.cpp" />
+    <ClCompile Include="headless.cpp" />
     <ClCompile Include="helpers\bitwriter.cpp" />
     <ClCompile Include="helpers\bytewriter.cpp" />
     <ClCompile Include="helpers\endianness.cpp" />
@@ -308,6 +310,7 @@
   </ItemGroup>
   <ItemGroup>
     <QtMoc Include="editor_state\ReachStringCentralModel.h" />
+    <ClInclude Include="cli.h" />
     <ClInclude Include="formats\indexed_lists.h" />
     <ClInclude Include="formats\ugc_header.h" />
     <ClInclude Include="game_variants\components\custom_game_options.h" />
@@ -352,6 +355,7 @@
     <ClInclude Include="game_variants\io_process.h" />
     <ClInclude Include="game_variants\types\firefight.h" />
     <ClInclude Include="game_variants\warnings.h" />
+    <ClInclude Include="headless.h" />
     <ClInclude Include="helpers\bitarray.h" />
     <ClInclude Include="helpers\ini\change_callback.h" />
     <ClInclude Include="helpers\ini\file.h" />

native/src/ReachVariantTool/ReachVariantTool.vcxproj.filters

@@ -481,6 +481,12 @@
     <ClCompile Include="helpers\ini\setting.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="cli.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
+    <ClCompile Include="headless.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <QtMoc Include="ui\generic\PlayerTraitWidgets.h">
@@ -1197,6 +1203,12 @@
     <ClInclude Include="helpers\ini\setting.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="cli.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
+    <ClInclude Include="headless.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <Image Include="ReachVariantTool.ico" />

native/src/ReachVariantTool/ReachVariantTool.vcxproj.user

@@ -5,11 +5,22 @@
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
     <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
+    <LocalDebuggerCommandArguments>
+    </LocalDebuggerCommandArguments>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
+    <LocalDebuggerCommandArguments>
+    </LocalDebuggerCommandArguments>
+    <DebuggerFlavor>WindowsLocalDebugger</DebuggerFlavor>
   </PropertyGroup>
   <PropertyGroup Label="QtSettings" Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
     <QtLastBackgroundBuild>2024-01-03T15:54:34.4610720Z</QtLastBackgroundBuild>
+    <QtTouchProperty>
+    </QtTouchProperty>
   </PropertyGroup>
   <PropertyGroup Label="QtSettings" Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
     <QtLastBackgroundBuild>2024-01-03T15:54:34.5920734Z</QtLastBackgroundBuild>
+    <QtTouchProperty>
+    </QtTouchProperty>
   </PropertyGroup>
 </Project>

native/src/ReachVariantTool/cli.cpp

@@ -0,0 +1,83 @@
+#include "./cli.h"
+#include <cstdio>
+#include <print>
+#include <string_view>
+#include "./rvt_version_macros.h"
+
+namespace rvt {
+   command_line_params::command_line_params(int argc, char* argv[]) {
+      if (argc <= 1)
+         return;
+
+      std::string_view operation = argv[1];
+      if (operation == "--help" || operation == "/?") {
+         this->help = true;
+         return;
+      }
+
+      if (operation == "--headless") {
+         this->headless = true;
+
+         //
+         // Currently supported commands:
+         // 
+         // <rvt-exe> --headless <in-variant> --recompile <in-source>
+         // <rvt-exe> --headless <in-variant> --recompile <in-source> --dst <out-variant>
+         //
+
+         if (argc < 3) {
+            this->has_error = true;
+            std::println(stderr, "To run RVT headlessly, you must specify a game variant file to modify.");
+            return;
+         }
+         this->game_variant.input = argv[2];
+
+         for (int i = 3; i < argc; ++i) {
+            std::string_view arg      = argv[i];
+            bool             has_next = i + 1 < argc;
+            if (arg == "--recompile") {
+               this->operation = headless_operation::recompile;
+               if (!has_next) {
+                  this->has_error = true;
+                  std::println(stderr, "Expected a file path (to a file with Megalo code) after `--recompile`.");
+                  return;
+               }
+               this->megalo_source = argv[i + 1];
+               ++i;
+               continue;
+            }
+            if (arg == "--dst") {
+               if (!has_next) {
+                  this->has_error = true;
+                  std::println(stderr, "Expected a file path (to save the modified game variant to) after `--dst`.");
+                  return;
+               }
+               this->game_variant.output = argv[i + 1];
+               ++i;
+               continue;
+            }
+            this->has_error = true;
+            std::println(stderr, "Unrecognized command line parameter; stopping. Parameter was: `{}`", arg);
+            return;
+         }
+      }
+   }
+
+   extern void print_cli_help() {
+      std::println("ReachVariantTool {}.{}.{}.{}", VER_MAJOR, VER_MINOR, VER_PATCH, VER_BUILD);
+      std::println("Available commands:");
+      std::println("--headless <in-variant> --recompile <in-source>");
+      std::println(
+         "   Loads the game variant at the <in-variant> file path. Loads the Megalo \n"
+         "   script source code at the <in-source> file path. Attempts to recompile \n"
+         "   the game variant's script; if successful, overwrites the game variant.\n"
+         "\n"
+      );
+      std::println("--headless <in-variant> --recompile <in-source> --dst <out-variant>");
+      std::println(
+         "   Same as above, but the recompiled game variant is saved to <out-variant> \n"
+         "   (if and only if recompilation succeeds).\n"
+         "\n"
+      );
+   }
+}

native/src/ReachVariantTool/cli.h

@@ -0,0 +1,26 @@
+#pragma once
+#include <filesystem>
+
+namespace rvt {
+   enum class headless_operation {
+      none,
+      recompile,
+   };
+
+   struct command_line_params {
+      command_line_params() {}
+      command_line_params(int argc, char* argv[]);
+
+      headless_operation operation = headless_operation::none;
+      bool has_error = false;
+      bool headless  = false;
+      bool help      = false;
+      struct {
+         std::filesystem::path input;
+         std::filesystem::path output; // if not specified, same as input
+      } game_variant;
+      std::filesystem::path megalo_source;
+   };
+
+   extern void print_cli_help();
+}

native/src/ReachVariantTool/docs/working - help docs/cli.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="utf-8" standalone="yes"?>
+<article>
+   <title>Command line interface</title>
+   <body>
+      <p>
+         ReachVariantTool can be run from the command line, with commands like these:
+      </p>
+      <pre>
+         ReachVariantTool /?
+         ReachVariantTool --help
+         ReachVariantTool --headless path/to/variant --recompile path/to/megalo
+         ReachVariantTool --headless path/to/variant --recompile path/to/megalo --dst path/to/output
+      </pre>
+      <hr />
+      <p>
+         The <code>--help</code> or <code>/?</code> command displays a list of available commands.
+      </p>
+      <p>
+         The <code>--headless</code> runs RVT without its GUI, loading a game variant as input. The 
+         <code>--recompile</code> operation allows you to load script source code from a file, try 
+         to compile it into the target variant, and then re-save it. If you specify <code>--dst</code>, 
+         then the recompiled variant will be saved to that destination (if compilation succeeds); 
+         otherwise, the original file is replaced.
+      </p>
+   </body>
+</article>

native/src/ReachVariantTool/docs/working - help docs/script/api/object.xml

@@ -1374,8 +1374,9 @@
                </arg>
                <arg name="type"  type="object-type" />
                <arg name="radius" type="number">
-                  Unknown. A value of 10 is equal to 1 Forge unit. Testing has not revealed any
-                  obvious effect. A value of 0 seems safe.
+                  The created object will have a cylinder shape, and this controls the radius. 
+                  A value of 10 represents one Forge unit. If the radius is zero or negative, 
+                  then the game will use 10 instead. Radii are clamped to the range [0, 200].
                </arg>
             </args>
             <blurb>Spawn a new object between this object and another.</blurb>
@@ -1385,7 +1386,10 @@
             <note>
                Unlike <a href="script/api/object/actions/place_at_me">object.place_at_me</a>,
                this function appears to spawn objects exactly in place, provided they aren't
-               solid or obstructed.
+               solid or obstructed. It also automatically gives the object a 
+               <a href="script/api/object/actions/set_shape">shape</a> &mdash; specifically, a 
+               cylinder, whose top and bottom lengths are set to reach from one basis object to 
+               the other basis object.
             </note>
             <note>
                If the same object is used as both basis objects &mdash; that is, if the object

native/src/ReachVariantTool/editor_state.cpp

@@ -27,6 +27,9 @@ namespace {
 }
 
 ReachEditorState::ReachEditorState() {
+
+   bool is_headless = qobject_cast<QGuiApplication*>(QApplication::instance()) == nullptr;
+
    QObject::connect(this, &ReachEditorState::stringModified, [this](uint32_t index) {
       auto mp = this->multiplayerData();
       if (!mp)
@@ -60,7 +63,7 @@ ReachEditorState::ReachEditorState() {
          }
       }
    }
-   {
+   if (!is_headless) {
       std::wstring dir;
       if (cobb::steam::get_game_directory(1695793, dir)) {
          QString hrek = QString::fromWCharArray(dir.c_str());