Add support for Oblivion Remastered

Author: Ortham

ffi/src/constants.rs

@@ -159,3 +159,7 @@ pub static LIBLO_GAME_STARFIELD: c_uint = 10;
 /// Game code for OpenMW.
 #[no_mangle]
 pub static LIBLO_GAME_OPENMW: c_uint = 11;
+
+/// Game code for The Elder Scrolls IV: Oblivion Remastered.
+#[no_mangle]
+pub static LIBLO_GAME_OBLIVION_REMASTERED: c_uint = 12;

ffi/src/handle.rs

@@ -31,8 +31,9 @@ use loadorder::WritableLoadOrder;
 use crate::constants::{
     LIBLO_ERROR_INVALID_ARGS, LIBLO_ERROR_PANICKED, LIBLO_ERROR_PATH_ENCODE_FAIL,
     LIBLO_ERROR_POISONED_THREAD_LOCK, LIBLO_GAME_FNV, LIBLO_GAME_FO3, LIBLO_GAME_FO4,
-    LIBLO_GAME_FO4VR, LIBLO_GAME_OPENMW, LIBLO_GAME_STARFIELD, LIBLO_GAME_TES3, LIBLO_GAME_TES4,
-    LIBLO_GAME_TES5, LIBLO_GAME_TES5SE, LIBLO_GAME_TES5VR, LIBLO_OK, LIBLO_WARN_LO_MISMATCH,
+    LIBLO_GAME_FO4VR, LIBLO_GAME_OBLIVION_REMASTERED, LIBLO_GAME_OPENMW, LIBLO_GAME_STARFIELD,
+    LIBLO_GAME_TES3, LIBLO_GAME_TES4, LIBLO_GAME_TES5, LIBLO_GAME_TES5SE, LIBLO_GAME_TES5VR,
+    LIBLO_OK, LIBLO_WARN_LO_MISMATCH,
 };
 use crate::helpers::{
     error, handle_error, to_c_string, to_c_string_array, to_path_buf_vec, to_str,
@@ -62,6 +63,7 @@ fn map_game_id(game_id: u32) -> Result<GameId, u32> {
         x if x == LIBLO_GAME_FO4VR => Ok(GameId::Fallout4VR),
         x if x == LIBLO_GAME_STARFIELD => Ok(GameId::Starfield),
         x if x == LIBLO_GAME_OPENMW => Ok(GameId::OpenMW),
+        x if x == LIBLO_GAME_OBLIVION_REMASTERED => Ok(GameId::OblivionRemastered),
         _ => Err(LIBLO_ERROR_INVALID_ARGS),
     }
 }

ffi/tests/ffi.cpp

@@ -23,6 +23,7 @@ void test_game_id_values() {
   assert(LIBLO_GAME_TES5VR == 9);
   assert(LIBLO_GAME_STARFIELD == 10);
   assert(LIBLO_GAME_OPENMW == 11);
+  assert(LIBLO_GAME_OBLIVION_REMASTERED == 12);
 }
 
 void test_lo_get_version() {

src/enums.rs

@@ -46,13 +46,14 @@ pub enum GameId {
     SkyrimVR,
     Starfield,
     OpenMW,
+    OblivionRemastered,
 }
 
 impl GameId {
     pub fn to_esplugin_id(self) -> esplugin::GameId {
         match self {
             GameId::Morrowind | GameId::OpenMW => esplugin::GameId::Morrowind,
-            GameId::Oblivion => esplugin::GameId::Oblivion,
+            GameId::Oblivion | GameId::OblivionRemastered => esplugin::GameId::Oblivion,
             GameId::Skyrim => esplugin::GameId::Skyrim,
             GameId::SkyrimSE | GameId::SkyrimVR => esplugin::GameId::SkyrimSE,
             GameId::Fallout3 => esplugin::GameId::Fallout3,

src/game_settings.rs

@@ -107,6 +107,8 @@ const MS_FO4_VAULT_TEC_PATH: &str = "../../Fallout 4- Vault-Tec Workshop (PC)/Co
 
 const PLUGINS_TXT: &str = "Plugins.txt";
 
+const OBLIVION_REMASTERED_RELATIVE_DATA_PATH: &str = "OblivionRemastered/Content/Dev/ObvData/Data";
+
 impl GameSettings {
     pub fn new(game_id: GameId, game_path: &Path) -> Result<GameSettings, Error> {
         let local_path = local_path(game_id, game_path)?.unwrap_or_default();
@@ -130,7 +132,7 @@ impl GameSettings {
         my_games_path: PathBuf,
     ) -> Result<GameSettings, Error> {
         let plugins_file_path = plugins_file_path(game_id, game_path, local_path)?;
-        let load_order_path = load_order_path(game_id, local_path);
+        let load_order_path = load_order_path(game_id, local_path, &plugins_file_path);
         let plugins_directory = plugins_directory(game_id, game_path, local_path)?;
         let additional_plugins_directories =
             additional_plugins_directories(game_id, game_path, &my_games_path)?;
@@ -167,7 +169,7 @@ impl GameSettings {
             GameId::Morrowind | GameId::Oblivion | GameId::Fallout3 | GameId::FalloutNV => {
                 LoadOrderMethod::Timestamp
             }
-            GameId::Skyrim => LoadOrderMethod::Textfile,
+            GameId::Skyrim | GameId::OblivionRemastered => LoadOrderMethod::Textfile,
             GameId::SkyrimSE
             | GameId::SkyrimVR
             | GameId::Fallout4
@@ -189,7 +191,7 @@ impl GameSettings {
     pub fn master_file(&self) -> &'static str {
         match self.id {
             GameId::Morrowind | GameId::OpenMW => "Morrowind.esm",
-            GameId::Oblivion => "Oblivion.esm",
+            GameId::Oblivion | GameId::OblivionRemastered => "Oblivion.esm",
             GameId::Skyrim | GameId::SkyrimSE | GameId::SkyrimVR => "Skyrim.esm",
             GameId::Fallout3 => "Fallout3.esm",
             GameId::FalloutNV => "FalloutNV.esm",
@@ -356,7 +358,7 @@ fn local_path(game_id: GameId, game_path: &Path) -> Result<Option<PathBuf>, Erro
 // The local path can vary depending on where the game was bought from.
 fn appdata_folder_name(game_id: GameId, game_path: &Path) -> Option<&'static str> {
     match game_id {
-        GameId::Morrowind | GameId::OpenMW => None,
+        GameId::Morrowind | GameId::OpenMW | GameId::OblivionRemastered => None,
         GameId::Oblivion => Some("Oblivion"),
         GameId::Skyrim => Some(skyrim_appdata_folder_name(game_path)),
         GameId::SkyrimSE => Some(skyrim_se_appdata_folder_name(game_path)),
@@ -444,6 +446,7 @@ fn my_games_path(
 fn my_games_folder_name(game_id: GameId, game_path: &Path) -> Option<&'static str> {
     match game_id {
         GameId::OpenMW => Some("OpenMW"),
+        GameId::OblivionRemastered => Some("Oblivion Remastered"),
         GameId::Skyrim => Some(skyrim_my_games_folder_name(game_path)),
         // For all other games the name is the same as the AppData\Local folder name.
         _ => appdata_folder_name(game_id, game_path),
@@ -461,11 +464,12 @@ fn skyrim_my_games_folder_name(game_path: &Path) -> &'static str {
 fn is_microsoft_store_install(game_id: GameId, game_path: &Path) -> bool {
     const APPX_MANIFEST: &str = "appxmanifest.xml";
 
+    // TODO: Oblivion Remastered - path to manifest is C:\XboxGames\The Elder Scrolls IV- Oblivion Remastered\Content\,
     match game_id {
         GameId::Morrowind | GameId::Oblivion | GameId::Fallout3 | GameId::FalloutNV => game_path
             .parent()
             .is_some_and(|parent| parent.join(APPX_MANIFEST).exists()),
-        GameId::SkyrimSE | GameId::Fallout4 | GameId::Starfield => {
+        GameId::SkyrimSE | GameId::Fallout4 | GameId::Starfield | GameId::OblivionRemastered => {
             game_path.join(APPX_MANIFEST).exists()
         }
         _ => false,
@@ -501,6 +505,7 @@ fn plugins_directory(
     match game_id {
         GameId::OpenMW => openmw_config::resources_vfs_path(game_path, local_path),
         GameId::Morrowind => Ok(game_path.join("Data Files")),
+        GameId::OblivionRemastered => Ok(game_path.join(OBLIVION_REMASTERED_RELATIVE_DATA_PATH)),
         _ => Ok(game_path.join("Data")),
     }
 }
@@ -529,9 +534,15 @@ fn additional_plugins_directories(
     }
 }
 
-fn load_order_path(game_id: GameId, local_path: &Path) -> Option<PathBuf> {
+fn load_order_path(
+    game_id: GameId,
+    local_path: &Path,
+    plugins_file_path: &Path,
+) -> Option<PathBuf> {
+    const LOADORDER_TXT: &str = "loadorder.txt";
     match game_id {
-        GameId::Skyrim => Some(local_path.join("loadorder.txt")),
+        GameId::Skyrim => Some(local_path.join(LOADORDER_TXT)),
+        GameId::OblivionRemastered => plugins_file_path.parent().map(|p| p.join(LOADORDER_TXT)),
         _ => None,
     }
 }
@@ -545,6 +556,9 @@ fn plugins_file_path(
         GameId::OpenMW => Ok(local_path.join("openmw.cfg")),
         GameId::Morrowind => Ok(game_path.join("Morrowind.ini")),
         GameId::Oblivion => oblivion_plugins_file_path(game_path, local_path),
+        GameId::OblivionRemastered => Ok(game_path
+            .join(OBLIVION_REMASTERED_RELATIVE_DATA_PATH)
+            .join(PLUGINS_TXT)),
         // Although the launchers for Fallout 3, Fallout NV and Skyrim all create plugins.txt, the
         // games themselves read Plugins.txt.
         _ => Ok(local_path.join(PLUGINS_TXT)),

src/ini.rs

@@ -125,7 +125,7 @@ pub(crate) fn test_files(
     my_games_path: &Path,
 ) -> Result<Vec<String>, Error> {
     match game_id {
-        GameId::Morrowind | GameId::OpenMW => Ok(Vec::new()),
+        GameId::Morrowind | GameId::OpenMW | GameId::OblivionRemastered => Ok(Vec::new()),
         GameId::Oblivion => {
             let ini_path = game_path.join("Oblivion.ini");