ModSource Design

[joshuaskelly]

Summary

Determine the initial design for the ModSource interface.

interface ModSource {
    // Get paths to all local mods.
    Array<String> getInstalledMods();

    // Get paths to all enabled mods.
    Array<String> getEnabledMods();

    // Get info for all available mods. These may not be locally installed.
    Array<ModData> getAvailableMods();

    // Get the UI to display for this source.
    WindowOverlay getUI();
}

Goals

• View all mods a source knows about.
• Enable/disable any given mod.
• Display UI for any custom needs a source may have.

Prior Art

There is some work existing around the Delver steam integration. See:

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

Line 460 in 5d88393

public WorkshopModData getDataForMod(String modPath) {

[joshuaskelly]

For a V0 UI is probably not needed.

[PythooonUser]

What could also be interesting is a refresh method that would allow to reindex the existing content, either locally or remote (and probably being called on start).

[PythooonUser]

Also, is there a specific reason to go with String instead directly with a FileHandle?

In order to keep the same behavior like the ModManager, maybe?

[joshuaskelly]

I don't think Refresh would be a common function.

Strings for simple serialization.