[WIP] Feature: Mod Browser

.gitignore

@@ -15,6 +15,8 @@ save/
 Dungeoneer/save/
 Dungeoneer/assets/packaged_files.txt
 DungeoneerDesktop/save
+**/mods/
+**/.mods/
 
 *.iml
 .idea/*

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

@@ -4,8 +4,6 @@
 import com.badlogic.gdx.files.FileHandle;
 import com.badlogic.gdx.utils.Array;
 import com.badlogic.gdx.utils.ArrayMap;
-import com.badlogic.gdx.utils.Json;
-import com.interrupt.api.steam.SteamApi;
 import com.interrupt.api.steam.workshop.WorkshopModData;
 import com.interrupt.dungeoneer.entities.Door;
 import com.interrupt.dungeoneer.entities.Entity;
@@ -14,6 +12,10 @@
 import com.interrupt.dungeoneer.gfx.TextureAtlas;
 import com.interrupt.dungeoneer.gfx.animation.lerp3d.LerpedAnimationManager;
 import com.interrupt.dungeoneer.gfx.shaders.ShaderData;
+import com.interrupt.dungeoneer.modding.InternalFileSystemModSource;
+import com.interrupt.dungeoneer.modding.ModInfo;
+import com.interrupt.dungeoneer.modding.ModSource;
+import com.interrupt.dungeoneer.modding.SteamWorkshopModSource;
 import com.interrupt.dungeoneer.scripting.ScriptingApi;
 import com.interrupt.managers.*;
 import com.interrupt.utils.JsonUtil;
@@ -22,6 +24,11 @@
 import java.util.HashMap;
 
 public class ModManager {
+    /** Array of sources to look for mod content. */
+    private Array<ModSource> sources = new Array<>();
+
+    /** Array of default sources to look for mod content. */
+    private transient Array<ModSource> defaultSources = new Array<>();
 
     private transient Array<String> allMods = new Array<String>();
 
@@ -56,11 +63,23 @@ public static void setScriptingApi(ScriptingApi newScriptingApi) {
     }
 
     private void loadModsEnabledList() {
+        defaultSources.clear();
+        sources.clear();
+
+        // Add default mod sources.
+        defaultSources.add(new InternalFileSystemModSource("mods"));
+        defaultSources.add(new SteamWorkshopModSource());
+
         try {
             FileHandle progressionFile = Game.getFile(Options.getOptionsDir() + "modslist.dat");
             if(progressionFile.exists()) {
                 ModManager loaded = JsonUtil.fromJson(ModManager.class, progressionFile);
+                sources = loaded.sources;
                 modsEnabled = loaded.modsEnabled;
+
+                for (ModSource source : sources) {
+                    source.init();
+                }
             }
         } catch (Exception e) {
             Gdx.app.error("DelverMods", e.getMessage());
@@ -89,13 +108,13 @@ private void findMods() {
         // add the default search paths
         allMods.add(".");
 
-        FileHandle fh = Game.getInternal("mods");
-        for(FileHandle h : fh.list()) {
-            if(h.isDirectory()) allMods.add("mods/" + h.name());
+        for (ModSource source : defaultSources) {
+            allMods.addAll(source.getInstalledMods());
         }
 
-        // add any mods subscribed in Steam Workshop
-        allMods.addAll(SteamApi.api.getWorkshopFolders());
+        for (ModSource source : sources) {
+            allMods.addAll(source.getInstalledMods());
+        }
     }
 
     private void filterMods() {
@@ -418,11 +437,11 @@ public GenTheme loadTheme(String filename) {
     }
 
     public boolean checkIfModIsEnabled(String mod) {
-        if(modsEnabled == null)
+        if (modsEnabled == null) {
             return true;
+        }
 
-        Boolean enabled = modsEnabled.get(mod);
-        return enabled == null || enabled;
+        return modsEnabled.getOrDefault(mod, true);
     }
 
     // Call refresh after changing this!
@@ -467,11 +486,24 @@ public WorkshopModData getDataForMod(String modPath) {
         }
     }
 
+    public ModInfo getModInfo(String path) {
+        try {
+            return JsonUtil.fromJson(ModInfo.class, new FileHandle(path).child("modInfo.json"));
+        }
+        catch (Exception ignored) {
+            return null;
+        }
+    }
+
     public String getModName(String modFolder) {
         if(Game.modManager != null) {
             WorkshopModData data = getDataForMod(modFolder);
             if(data != null && data.title != null && !data.title.isEmpty())
                 return data.title;
+
+            ModInfo modInfo = getModInfo(modFolder);
+            if (modInfo != null && modInfo.name != null && !modInfo.name.isEmpty())
+                return modInfo.name;
         }
 
         FileHandle path = new FileHandle(modFolder);

Dungeoneer/src/com/interrupt/dungeoneer/modding/AbstractFileSystemModSource.java

@@ -0,0 +1,36 @@
+package com.interrupt.dungeoneer.modding;
+
+import com.badlogic.gdx.files.FileHandle;
+import com.badlogic.gdx.utils.Array;
+
+public abstract class AbstractFileSystemModSource implements ModSource {
+    /** The root file path to look for mod content. */
+    protected String root;
+
+    protected AbstractFileSystemModSource() {
+    }
+
+    protected AbstractFileSystemModSource(String root) {
+        this.root = root;
+    }
+
+    protected abstract FileHandle getRootHandle();
+
+    @Override
+    public Array<String> getInstalledMods() {
+        Array<String> mods = new Array<>();
+        FileHandle rootHandle = getRootHandle();
+
+        if (!rootHandle.isDirectory()) {
+            return mods;
+        }
+
+        for (FileHandle childHandle : rootHandle.list()) {
+            if (childHandle.isDirectory()) {
+                mods.add(childHandle.path());
+            }
+        }
+
+        return mods;
+    }
+}

Dungeoneer/src/com/interrupt/dungeoneer/modding/GitHubRepoModSource.java

@@ -0,0 +1,102 @@
+package com.interrupt.dungeoneer.modding;
+
+import java.util.HashMap;
+import java.util.UUID;
+
+import com.badlogic.gdx.files.FileHandle;
+import com.interrupt.dungeoneer.game.Game;
+import com.interrupt.dungeoneer.net.DownloadListenerAdapter;
+import com.interrupt.utils.DownloadUtils;
+import com.interrupt.utils.JsonUtil;
+import com.interrupt.utils.ZipUtils;
+
+public class GitHubRepoModSource extends LocalFileSystemModSource {
+    private String username;
+    private String repository;
+    private boolean hasMultipleMods;
+
+    private transient String downloadsPath;
+    private transient String modsPath;
+
+    @Override
+    public void init() {
+        if (root == null || root.isEmpty()) {
+            root = ".mods/github/";
+        }
+
+        if (!root.endsWith("/"))
+            root += "/";
+
+        downloadsPath = root + ".downloads/";
+        modsPath = root + "mods/";
+
+        refresh();
+    }
+
+    @Override
+    protected FileHandle getRootHandle() {
+        return Game.getFile(modsPath);
+    }
+
+    public void refresh() {
+        HashMap<String, String> header = new HashMap<>();
+        header.put("Accept", "application/vnd.github.v3+json");
+
+        String url = "https://api.github.com/repos/" + this.username + "/" + this.repository + "/zipball";
+        String filename = this.username + "-" + this.repository + ".zip";
+        String filepath = downloadsPath + filename;
+
+        FileHandle file = Game.getFile(filepath);
+        if (!file.exists()) {
+            DownloadUtils.downloadFile(url, filepath, header, new DownloadListenerAdapter() {
+                @Override
+                public void completed(FileHandle file) {
+                    // Extract contents to temporary path.
+                    FileHandle path = Game.getFile(downloadsPath + "/" + username + "-" + repository + "/");
+                    ZipUtils.extract(file, path);
+
+                    // Move into actual repository root.
+                    FileHandle[] innerRoot = path.list();
+                    path = innerRoot[0];
+
+                    if (hasMultipleMods) {
+                        for (FileHandle root : path.list()) {
+                            if (!root.isDirectory())
+                                continue;
+
+                            FileHandle modInfoPath = root.child("modInfo.json");
+                            if (!modInfoPath.exists()) {
+                                ModInfo modInfo = new ModInfo();
+                                modInfo.id = UUID.randomUUID().getMostSignificantBits() & Long.MAX_VALUE;
+                                modInfo.name = root.nameWithoutExtension();
+
+                                JsonUtil.toJson(modInfo, modInfoPath);
+                            }
+
+                            FileHandle destination = new FileHandle(modsPath + "/" + username + "-" + repository + "-" + root.nameWithoutExtension() + "/");
+                            destination.mkdirs();
+                            for (FileHandle item : root.list()) {
+                                item.copyTo(destination);
+                            }
+                        }
+                    } else {
+                        FileHandle modInfoPath = path.child("modInfo.json");
+                        if (!modInfoPath.exists()) {
+                            ModInfo modInfo = new ModInfo();
+                            modInfo.id = 0;
+                            modInfo.name = username + "-" + repository;
+
+                            JsonUtil.toJson(modInfo, modInfoPath);
+                        }
+
+                        FileHandle destination = new FileHandle(modsPath + "/" + username + "-" + repository + "/");
+                        destination.mkdirs();
+                        for (FileHandle item : path.list()) {
+                            item.copyTo(destination);
+                        }
+                    }
+                }
+            });
+        }
+    }
+}

Dungeoneer/src/com/interrupt/dungeoneer/modding/InternalFileSystemModSource.java

@@ -0,0 +1,20 @@
+package com.interrupt.dungeoneer.modding;
+
+import com.badlogic.gdx.files.FileHandle;
+import com.interrupt.dungeoneer.game.Game;
+
+public class InternalFileSystemModSource extends AbstractFileSystemModSource {
+    public InternalFileSystemModSource(String root) {
+        super(root);
+    }
+
+    @Override
+    protected FileHandle getRootHandle() {
+        return Game.getInternal(root);
+    }
+
+    @Override
+    public void init() {
+
+    }
+}

Dungeoneer/src/com/interrupt/dungeoneer/modding/LocalFileSystemModSource.java

@@ -0,0 +1,16 @@
+package com.interrupt.dungeoneer.modding;
+
+import com.badlogic.gdx.files.FileHandle;
+import com.interrupt.dungeoneer.game.Game;
+
+public class LocalFileSystemModSource extends AbstractFileSystemModSource {
+    @Override
+    protected FileHandle getRootHandle() {
+        return Game.getFile(root);
+    }
+
+    @Override
+    public void init() {
+
+    }
+}

Dungeoneer/src/com/interrupt/dungeoneer/modding/ModIOModSource.java

@@ -0,0 +1,88 @@
+package com.interrupt.dungeoneer.modding;
+
+import com.badlogic.gdx.Gdx;
+import com.badlogic.gdx.Net;
+import com.badlogic.gdx.Net.HttpRequest;
+import com.badlogic.gdx.net.HttpRequestBuilder;
+import com.badlogic.gdx.files.FileHandle;
+import com.interrupt.dungeoneer.game.Game;
+import com.interrupt.dungeoneer.modding.modio.*;
+import com.interrupt.dungeoneer.net.DownloadListenerAdapter;
+import com.interrupt.dungeoneer.net.ObjectResponseListener;
+import com.interrupt.utils.DownloadUtils;
+import com.interrupt.utils.JsonUtil;
+import com.interrupt.utils.ZipUtils;
+
+public class ModIOModSource extends LocalFileSystemModSource {
+    private int gameID;
+    private String apiKey;
+
+    private transient String downloadsPath;
+    private transient String modsPath;
+
+    @Override
+    public void init() {
+        if (root == null || root.isEmpty()) {
+            root = ".mods/modio/";
+        }
+
+        if (!root.endsWith("/")) root += "/";
+
+        downloadsPath = root + ".downloads/";
+        modsPath = root + "mods/";
+
+        refresh();
+    }
+
+    @Override
+    protected FileHandle getRootHandle() {
+        return Game.getFile(modsPath);
+    }
+
+    public void refresh() {
+        HttpRequestBuilder requestBuilder = new HttpRequestBuilder();
+        HttpRequest request = requestBuilder
+            .newRequest()
+            .method(Net.HttpMethods.GET)
+            .header("User-Agent", "delverengine/" + Game.VERSION)
+            .url("https://api.test.mod.io/v1/games/" + gameID + "/mods")
+            .content("api_key=" + apiKey)
+            .build();
+
+        Gdx.net.sendHttpRequest(request, new ObjectResponseListener<GetMods>(GetMods.class) {
+            @Override
+            public void handleObjectResponse(GetMods mods) {
+                for (ModObject mod : mods.data) {
+                    String url = mod.modfile.download.binary_url;
+                    String filename = mod.modfile.filename;
+                    String filepath = downloadsPath + filename;
+
+                    FileHandle file = Game.getFile(filepath);
+                    if (!file.exists()) {
+                        DownloadUtils.downloadFile(
+                            url,
+                            filepath,
+                            null,
+                            new DownloadListenerAdapter() {
+                                @Override
+                                public void completed(FileHandle file) {
+                                    FileHandle path = Game.getFile(modsPath + "/" + mod.id + "/");
+                                    ZipUtils.extract(file, path);
+
+                                    FileHandle modInfoPath = path.child("modInfo.json");
+                                    if (!modInfoPath.exists()) {
+                                        ModInfo modInfo = new ModInfo();
+                                        modInfo.id = mod.id;
+                                        modInfo.name = mod.name;
+
+                                        JsonUtil.toJson(modInfo, modInfoPath);
+                                    }
+                                }
+                            }
+                        );
+                    }
+                }
+            }
+        });
+    }
+}

Dungeoneer/src/com/interrupt/dungeoneer/modding/ModInfo.java

@@ -0,0 +1,6 @@
+package com.interrupt.dungeoneer.modding;
+
+public class ModInfo {
+    public long id;
+    public String name;
+}