Letting a mod override all of the base game data, like an iWad would in Doom (#293)

* Letting a mod override all of the base game data, like an iWad would in Doom

* Ensure base mod is always at the beginning

* Updating JSON schema for GameData.dat

Author: Interrupt

Dungeoneer/src/com/interrupt/dungeoneer/game/GameData.java

@@ -32,6 +32,10 @@ public GameData() { }
     /** Is player allowed to jump? */
     public boolean playerJumpEnabled = false;
 
+    /** Whether the mod including this should override the packaged game data.
+     * Setting this to true makes the mod basically the Delver version of an iWad in Doom. */
+    public boolean overrideBaseGame = false;
+
     public void merge(GameData modData) {
         tutorialLevel = modData.tutorialLevel;
         endingLevel = modData.endingLevel;

Dungeoneer/src/com/interrupt/dungeoneer/game/ModManager.java

@@ -4,6 +4,7 @@
 import com.badlogic.gdx.files.FileHandle;
 import com.badlogic.gdx.utils.Array;
 import com.badlogic.gdx.utils.ArrayMap;
+import com.badlogic.gdx.utils.ObjectMap;
 import com.interrupt.api.steam.SteamApi;
 import com.interrupt.api.steam.workshop.WorkshopModData;
 import com.interrupt.dungeoneer.entities.Door;
@@ -82,18 +83,51 @@ public void refresh() {
         findMods();
         filterMods();
         loadExcludesList();
+
+        // Find which path should be the base
+        String baseAssetPath = getBaseAssetPath();
+
+        // If the base path is just the prepackaged data, stop here
+        if(baseAssetPath.equals("."))
+            return;
+
+        // Make sure the new base path is only in once, at the beginning
+        modsFound.removeValue(baseAssetPath, false);
+        modsFound.set(0, baseAssetPath);
+    }
+
+    private String getBaseAssetPath() {
+        // Check if any of the game data files override the baked in assets. Use the first found.
+        ArrayMap<String, GameData> foundGameData = findAllGameData();
+        for(ObjectMap.Entry<String, GameData> mapPair : foundGameData) {
+            // Ignore this entry if it is actually the packaged game
+            if(mapPair.key.equals("."))
+                continue;
+
+            if(mapPair.value.overrideBaseGame)
+                return mapPair.key;
+        }
+
+        // Default to the internally packaged data.
+        return ".";
     }
 
     private void findMods() {
         // reset
         allMods.clear();
 
-        // add the default search paths
+        // add the baked in data path
         allMods.add(".");
 
         FileHandle fh = Game.getInternal("mods");
         for(FileHandle h : fh.list()) {
-            if(h.isDirectory()) allMods.add("mods/" + h.name());
+            if(h.isDirectory()) {
+                String modPath = "mods/" + h.name();
+
+                // Ensure mod paths only get added once
+                if(!allMods.contains(modPath, false))
+                    allMods.add(modPath);
+            }
         }
 
         // add any mods subscribed in Steam Workshop
@@ -316,19 +350,34 @@ public HashMap<String, LocalizedString> loadLocalizedStrings() {
         return combinedLocalizedStrings;
     }
 
-    public GameData loadGameData() {
-        GameData gameData = new GameData();
+    public ArrayMap<String, GameData> findAllGameData() {
+        ArrayMap<String, GameData> foundGameData = new ArrayMap<>();
 
         for(String path : modsFound) {
             try {
                 FileHandle modFile = Game.getInternal(path + "/data/game.dat");
                 if(modFile.exists() && !pathIsExcluded(path + "/data/game.dat")) {
                     GameData modData = JsonUtil.fromJson(GameData.class, modFile);
-                    gameData.merge(modData);
+                    foundGameData.put(path, modData);
                 }
             }
             catch(Exception ex) {
-                Gdx.app.error("Delver", "Error loading mod file " + path + "/data/game.dat");
+                Gdx.app.error("Delver", "Error loading game data file " + path + "/data/game.dat");
+                Logger.logExceptionToFile(ex);
+            }
+        }
+
+        return foundGameData;
+    }
+
+    public GameData loadGameData() {
+        GameData gameData = new GameData();
+
+        for(GameData modData : findAllGameData().values()) {
+            try {
+                gameData.merge(modData);
+            } catch(Exception ex) {
+                Gdx.app.error("Delver", ex.getMessage());
                 Logger.logExceptionToFile(ex);
             }
         }

jsonschema/current/dungeoneer/game/GameData.schema.json

@@ -57,6 +57,11 @@
             "type": "boolean",
             "default": false,
             "description": "Is player allowed to jump."
+        },
+        "overrideBaseGame": {
+            "type": "boolean",
+            "default": false,
+            "description": "Whether the mod including this should override the packaged game data."
         }
     },
     "required": [