[ENHANCEMENT] Add lua for assets library

[AltronMaxX]

Polymod wont replace properly lua files, that makes game not finding this lua files.

[EliteMasterEric]

This is interesting, replacement shouldn't depend on file type.

What does your setup look like? Can you create a minimal reproduction I can work with?

[AltronMaxX]

Well, I have this code ;)

`import flixel.FlxG; import polymod.Polymod;

if FEATURE_MODCORE

import polymod.backends.OpenFLBackend; import polymod.backends.PolymodAssets.PolymodAssetType; import polymod.format.ParseRules.LinesParseFormat; import polymod.format.ParseRules.TextFileFormat; import polymod.Polymod;

end

/**

• Okay now this is epic. */ class ModCore { /**

  • The current API version.
  • Must be formatted in Semantic Versioning v2; ...
  • Remember to increment the major version if you make breaking changes to mods! */ static final API_VERSION = "0.1.0";

  static final MOD_DIRECTORY = "mods";

  public static function loadConfiguredMods() {

  if FEATURE_MODCORE

      Debug.logInfo("Initializing ModCore (using user config)...");
      Debug.logTrace('  User mod config: ${FlxG.save.data.modConfig}');
      var userModConfig = getConfiguredMods();
      loadModsById(userModConfig);
      #else
      Debug.logInfo("ModCore not initialized; not supported on this platform.");
      #end
  }
  
  /**
   * If the user has configured an order of mods to load, returns the list of mod IDs in order.
   * Otherwise, returns a list of ALL installed mods in alphabetical order.
   * @return The mod order to load.
   */
  public static function getConfiguredMods():Array<String>
  {
      var rawSaveData = FlxG.save.data.modConfig;
  
      if (rawSaveData != null)
      {
          var modEntries = rawSaveData.split('~');
          return modEntries;
      }
      else
      {
          // Mod list not in save!
          return null;
      }
  }
  
  public static function hasMods():Bool
      {
          #if FEATURE_MODCORE
          return getAllMods().length > 0;
          #else
          return false;
          #end
      }
  
  public static function saveModList(loadedMods:Array<String>)
  {
      Debug.logInfo('Saving mod configuration...');
      var rawSaveData = loadedMods.join('~');
      Debug.logTrace(rawSaveData);
      FlxG.save.data.modConfig = rawSaveData;
      var result = FlxG.save.flush();
      if (result)
          Debug.logInfo('Mod configuration saved successfully.');
      else
          Debug.logWarn('Failed to save mod configuration.');
  }   

  if FEATURE_MODCORE

  public static function loadModsById(ids:Array) {

  if FEATURE_MODCORE

      if (ids.length == 0)
      {
          Debug.logWarn('You attempted to load zero mods.');
      }
      else
      {
          Debug.logInfo('Attempting to load ${ids.length} mods...');
      }
      var loadedModList = polymod.Polymod.init({
          // Root directory for all mods.
          modRoot: MOD_DIRECTORY,
          // The directories for one or more mods to load.
          dirs: ids,
          // Framework being used to load assets. We're using a CUSTOM one which extends the OpenFL one.
          framework: CUSTOM,
          // The current version of our API.
          apiVersion: API_VERSION,
          // Call this function any time an error occurs.
          errorCallback: onPolymodError,
          // Enforce semantic version patterns for each mod.
          // modVersions: null,
          // A map telling Polymod what the asset type is for unfamiliar file extensions.
          // extensionMap: [],
  
          frameworkParams: buildFrameworkParams(),
  
          // Use a custom backend so we can get a picture of what's going on,
          // or even override behavior ourselves.
          customBackend: ModCoreBackend,
  
          // List of filenames to ignore in mods. Use the default list to ignore the metadata file, etc.
          ignoredFiles: Polymod.getDefaultIgnoreList(),
  
          // Parsing rules for various data formats.
          parseRules: buildParseRules(),
      });
  
      if (loadedModList == null)
      {
          Debug.logError('Mod loading failed, check above for a message from Polymod explaining why.');
      }
      else
      {
          if (loadedModList.length == 0)
          {
              Debug.logInfo('Mod loading complete. We loaded no mods / ${ids.length} mods.');
          }
          else
          {
              Debug.logInfo('Mod loading complete. We loaded ${loadedModList.length} / ${ids.length} mods.');
          }
      }
  
      /*for (mod in loadedModList)
          Debug.logTrace('  * ${mod.title} v${mod.modVersion} [${mod.id}]');*/
  
      var fileList = Polymod.listModFiles("IMAGE");
      Debug.logInfo('Installed mods have replaced ${fileList.length} images.');
      for (item in fileList)
          Debug.logTrace('  * $item');
  
      fileList = Polymod.listModFiles("TEXT");
      Debug.logInfo('Installed mods have replaced ${fileList.length} text files.');
      for (item in fileList)
          Debug.logTrace('  * $item');
  
      fileList = Polymod.listModFiles("MUSIC");
      Debug.logInfo('Installed mods have replaced ${fileList.length} music files.');
      for (item in fileList)
          Debug.logTrace('  * $item');
  
      fileList = Polymod.listModFiles("SOUND");
      Debug.logInfo('Installed mods have replaced ${fileList.length} sound files.');
      for (item in fileList)
          Debug.logTrace('  * $item');
      #else
      Debug.logWarn("Attempted to load mods when Polymod was not supported!");
      #end
  }

  public static function getAllMods():Array { Debug.logInfo('Scanning the mods folder...'); var modMetadata = Polymod.scan(MOD_DIRECTORY); Debug.logInfo('Found ${modMetadata.length} mods when scanning.'); return modMetadata; }

  static function getModIds():Array { Debug.logInfo('Scanning the mods folder...'); var modMetadata = Polymod.scan(MOD_DIRECTORY); Debug.logInfo('Found ${modMetadata.length} mods when scanning.'); var modIds = [for (i in modMetadata) i.id]; return modIds; }

  static function buildParseRules():polymod.format.ParseRules { var output = polymod.format.ParseRules.getDefault(); // Ensure TXT files have merge support. output.addType("txt", TextFileFormat.LINES);

  // You can specify the format of a specific file, with file extension.
  // output.addFile("data/introText.txt", TextFileFormat.LINES)
  return output;

  }

  static inline function buildFrameworkParams():polymod.FrameworkParams { return { assetLibraryPaths: [ "default" => "./preload", // ./preload "sm" => "./sm", "songs" => "./songs", "shared" => "./", "tutorial" => "./tutorial", "scripts" => "./scripts", "week1" => "./week1", "week2" => "./week2", "week3" => "./week3", "week4" => "./week4", "week5" => "./week5", "week6" => "./week6", 'core' => './_core' // Don't override these files. ] } }

  static function onPolymodError(error:PolymodError):Void { // Perform an action based on the error code. switch (error.code) { // case "parse_mod_version": // case "parse_api_version": // case "parse_mod_api_version": // case "missing_mod": // case "missing_meta": // case "missing_icon": // case "version_conflict_mod": // case "version_conflict_api": // case "version_prerelease_api": // case "param_mod_version": // case "framework_autodetect": // case "framework_init": // case "undefined_custom_backend": // case "failed_create_backend": // case "merge_error": // case "append_error": default: // Log the message based on its severity. switch (error.severity) { case NOTICE: Debug.logInfo(error.message, null); case WARNING: Debug.logWarn(error.message, null); case ERROR: Debug.logError(error.message, null); } } }

  end

  }

if FEATURE_MODCORE

class ModCoreBackend extends OpenFLBackend { public function new() { super(); Debug.logTrace('Initialized custom asset loader backend.'); }

public override function clearCache()
{
    super.clearCache();
    Debug.logWarn('Custom asset cache has been cleared.');
}

public override function exists(id:String):Bool
{
    Debug.logTrace('Call to ModCoreBackend: exists($id)');
    return super.exists(id);
}

public override function getBytes(id:String):lime.utils.Bytes
{
    Debug.logTrace('Call to ModCoreBackend: getBytes($id)');
    return super.getBytes(id);
}

public override function getText(id:String):String
{
    Debug.logTrace('Call to ModCoreBackend: getText($id)');
    return super.getText(id);
}

public override function list(type:PolymodAssetType = null):Array<String>
{
    Debug.logTrace('Listing assets in custom asset cache ($type).');
    return super.list(type);
}

}

end`

[AltronMaxX]

Console tells, that polymode trying to replace every type of file to lua

[EliteMasterEric]

That looks like... Old code copied from Enigma?

Can you copy and paste the message the console says?

[AltronMaxX]

Yes, this code from Enigma ;)

Concole says this about replacing lua 0:16.58 [INFO ] (ModCore/loadModsById#144): Mod loading complete. We loaded 1 / 1 mods. 0:16.58 [INFO ] (ModCore/loadModsById#152): Installed mods have replaced 3 images. 0:16.59 [TRACE] (ModCore/loadModsById#154): images/manifest/floorManifest.png 0:16.59 [TRACE] (ModCore/loadModsById#154): stages/manifest.lua 0:16.59 [TRACE] (ModCore/loadModsById#154): images/manifest/bg_manifest.png 0:16.59 [INFO ] (ModCore/loadModsById#157): Installed mods have replaced 3 text files. 0:16.60 [TRACE] (ModCore/loadModsById#159): images/manifest/bg_manifest.xml 0:16.60 [TRACE] (ModCore/loadModsById#159): stages/manifest.lua 0:16.60 [TRACE] (ModCore/loadModsById#159): images/manifest/floorManifest.xml 0:16.61 [INFO ] (ModCore/loadModsById#162): Installed mods have replaced 1 music files. 0:16.61 [TRACE] (ModCore/loadModsById#164): stages/manifest.lua 0:16.61 [INFO ] (ModCore/loadModsById#167): Installed mods have replaced 1 sound files. 0:16.62 [TRACE] (ModCore/loadModsById#169): stages/manifest.lua

[AltronMaxX]

I have noticed that on Polymod init I can make custom extension map.

[AltronMaxX]

Fixed this "fun" by using OpenFl Assets instead of FileSystem