[WIP] Add support for Starfield

This is WIP because the libraries it depends on are unreleased, and there are no tests.

CMakeLists.txt

@@ -80,8 +80,8 @@ set(GTEST_LIBRARIES "${BINARY_DIR}/lib/${CMAKE_CFG_INTDIR}/${CMAKE_STATIC_LIBRAR
 
 ExternalProject_Add(esplugin
     PREFIX "external"
-    URL "https://github.com/Ortham/esplugin/archive/4.0.0.tar.gz"
-    URL_HASH "SHA256=e3aa21ffbfd8ce55e3398fbd789adb2aa0d2cceefc99bcc789f02ff95cc98b86"
+    URL "https://github.com/Ortham/esplugin/archive/starfield.tar.gz"
+    #URL_HASH "SHA256=e3aa21ffbfd8ce55e3398fbd789adb2aa0d2cceefc99bcc789f02ff95cc98b86"
     CONFIGURE_COMMAND ""
     BUILD_IN_SOURCE 1
     BUILD_COMMAND cargo build --release --manifest-path ffi/Cargo.toml --target ${RUST_TARGET} &&
@@ -98,8 +98,8 @@ endif()
 
 ExternalProject_Add(libloadorder
     PREFIX "external"
-    URL "https://github.com/Ortham/libloadorder/archive/14.2.1.tar.gz"
-    URL_HASH "SHA256=4341844407f55ce9d96826a933ac35dfb22bbad14906e5dff742f910182eca93"
+    URL "https://github.com/Ortham/libloadorder/archive/starfield.tar.gz"
+    #URL_HASH "SHA256=4341844407f55ce9d96826a933ac35dfb22bbad14906e5dff742f910182eca93"
     CONFIGURE_COMMAND ""
     BUILD_IN_SOURCE 1
     BUILD_COMMAND cargo build --release --manifest-path ffi/Cargo.toml --target ${RUST_TARGET} &&
@@ -116,8 +116,8 @@ endif()
 
 ExternalProject_Add(loot-condition-interpreter
     PREFIX "external"
-    URL "https://github.com/loot/loot-condition-interpreter/archive/3.0.0.tar.gz"
-    URL_HASH "SHA256=6492c19848f01f297537da6a561e8d0c0a79e7c15e3ddf958910dec7cdfe0abf"
+    URL "https://github.com/loot/loot-condition-interpreter/archive/starfield.tar.gz"
+    #URL_HASH "SHA256=6492c19848f01f297537da6a561e8d0c0a79e7c15e3ddf958910dec7cdfe0abf"
     CONFIGURE_COMMAND ""
     BUILD_IN_SOURCE 1
     BUILD_COMMAND cargo build --release --manifest-path ffi/Cargo.toml --target ${RUST_TARGET} &&

include/loot/enum/game_type.h

@@ -49,6 +49,8 @@ enum struct GameType : unsigned int {
   tes5vr,
   /** The Elder Scrolls III: Morrowind */
   tes3,
+  /** Starfield */
+  starfield
 };
 }
 

include/loot/plugin_interface.h

@@ -99,13 +99,26 @@ class PluginInterface {
    */
   virtual bool IsLightPlugin() const = 0;
 
+  /**
+   * Check if the plugin is an override plugin.
+   * @return True if plugin is an override plugin, false otherwise.
+   */
+  virtual bool IsOverridePlugin() const = 0;
+
   /**
    * Check if the plugin is or would be valid as a light plugin.
    * @return True if the plugin is a valid light plugin or would be a valid
    *         light plugin, false otherwise.
    */
   virtual bool IsValidAsLightPlugin() const = 0;
 
+  /**
+   * Check if the plugin is or would be valid as an override plugin.
+   * @return True if the plugin is a valid override plugin or would be a valid
+   *         override plugin, false otherwise.
+   */
+  virtual bool IsValidAsOverridePlugin() const = 0;
+
   /**
    * Check if the plugin contains any records other than its TES4 header.
    * @return True if the plugin only contains a TES4 header, false otherwise.

src/api/api.cpp

@@ -52,6 +52,8 @@ const char* DescribeGameType(GameType gameType) {
       return "The Elder Scrolls V: Skyrim VR";
     case GameType::tes3:
       return "The Elder Scrolls III: Morrowind";
+    case GameType::starfield:
+      return "Starfield";
     default:
       return "Unknown";
   }

src/api/bsa.cpp

@@ -142,7 +142,7 @@ void StoreHashes(std::map<uint64_t, std::set<uint64_t>>& folderFileHashes,
   }
 }
 
-// Normalise the path the same way that BA2 hashes do (it's thet same as for
+// Normalise the path the same way that BA2 hashes do (it's the same as for
 // BSAs).
 void NormalisePath(std::string& filePath) {
   for (size_t i = 0; i < filePath.size(); ++i) {
@@ -217,7 +217,8 @@ std::map<uint64_t, std::set<uint64_t>> GetAssetsInBA2(std::istream& in,
     throw std::runtime_error("BA2 file header type ID is invalid");
   }
 
-  if (header.version != 1) {
+  // The header version is 1 for Fallout 4 and 2 or 3 for Starfield.
+  if (header.version != 1 && header.version != 2 && header.version != 3) {
     throw std::runtime_error("BA2 file header version is invalid");
   }
 
@@ -237,7 +238,7 @@ std::map<uint64_t, std::set<uint64_t>> GetAssetsInBA2(std::istream& in,
 bool ShouldWarnAboutHashCollisions(const std::filesystem::path& archivePath) {
   const auto filename = archivePath.filename().u8string();
 
-  return !boost::iends_with(filename, ".ba2") ||
+  return !boost::iends_with(filename, BA2_FILE_EXTENSION) ||
          (!boost::istarts_with(filename, "Fallout4 - ") &&
           !boost::istarts_with(filename, "DLCUltraHighResolution - "));
 }

src/api/bsa.h

@@ -31,6 +31,9 @@
 #include <vector>
 
 namespace loot {
+static constexpr const char* BSA_FILE_EXTENSION = ".bsa";
+static constexpr const char* BA2_FILE_EXTENSION = ".ba2";
+
 std::map<uint64_t, std::set<uint64_t>> GetAssetsInBethesdaArchive(
     const std::filesystem::path& archivePath);
 

src/api/game/game.cpp

@@ -84,9 +84,14 @@ bool IsMicrosoftStoreInstall(const GameType gameType,
                                      "appxmanifest.xml");
     case GameType::tes5se:
     case GameType::fo4:
+    case GameType::starfield:
       return std::filesystem::exists(gamePath / "appxmanifest.xml");
-    default:
+    case GameType::tes5:
+    case GameType::tes5vr:
+    case GameType::fo4vr:
       return false;
+    default:
+      throw std::logic_error("Unrecognised game type");
   }
 }
 

src/api/game/load_order_handler.cpp

@@ -48,6 +48,8 @@ unsigned int mapGameId(GameType gameType) {
       return LIBLO_GAME_FO4;
     case GameType::fo4vr:
       return LIBLO_GAME_FO4VR;
+    case GameType::starfield:
+      return LIBLO_GAME_STARFIELD;
     default:
       throw std::logic_error("Unexpected game type");
   }

src/api/metadata/condition_evaluator.cpp

@@ -73,6 +73,8 @@ int mapGameType(GameType gameType) {
       return LCI_GAME_FALLOUT_4;
     case GameType::fo4vr:
       return LCI_GAME_FALLOUT_4_VR;
+    case GameType::starfield:
+      return LCI_GAME_STARFIELD;
     default:
       throw std::runtime_error(
           "Unrecognised game type encountered while mapping for condition "