Modlist UI


Display and share your active mods during gameplay in a convenient interface.

Utilities
8 days ago
2.0 - 2.1
375

FAQ

Latest --- Where are the mod thumbnails?

By default, thumbnails are disabled, [No Thumbnails] so Modlist UI and Factorio starts up safely. This is essentially a "fail-safe" should you ever need to reset your mod-settings.

To show thumbnails, go into Settings --> Mod Settings --> Startup tab --> Modlist UI: [Version Matched] or [Latest Version]

  • [No Thumbnails]: Self-explanatory. Default "fail-safe" setting when forced to reset mod-settings. Ensures Modlist UI always loads.
  • [Version Matched]: Only show thumbnails for mods which match [portal_blob.lua] entries using the same Factorio branch you are using, i.e. 2.0 or 2.1
  • [Latest Version]: [Recommended for Factorio 2.1 users] Use the latest mod entry in [factorio_modportal_blob.lua] for thumbnail metadata.

Latest --- Startup crash: missing thumbnail / wrong dimensions / out of bounds

  1. Manually download the latest Factorio 2.1 version of Modlist UI, and extract its [factorio_modportal_blob.lua] file.
  2. Manually download the latest version of the problematic mod mentioned in the crash-error, and extract its [thumbnail.jpg]
  3. Manually replace both files in their respective installed mods' folders with the extracted ones. Repeat step 2 and 3 as necessary.

Latest --- What is this “blob” / [factorio_modportal_blob.lua]?

A user's current active modlist only provides a list of slug/name, i.e. [modlist-ui], and version. Anything more requires external provision.

In Modlist UI's folder, you will find [factorio_modportal_blob.lua]. It is a large metadata file generated by scraping all 7,200+ [2.0] and [2.1] mods' metadata on the Factorio Mod Portal, providing Modlist UI richer information: titles, authors, descriptions, and crucially: thumbnail availability and dimensions.

Displaying thumbnails requires writing a graphic to the spritesheet during game-startup and then referencing it in game. Resizing/cropping/centering sprites requires knowing its dimensions. Not every mod has a thumbnail and no dimension size is standardized/agreed upon, except their filename: [thumbnail.jpg].

The game will crash during startup/runtime if we:
- Attempt to reference a thumbnail/file that does not exist. Some mods just don't have a thumbnail. Boo.
- Attempt to resize/crop an image outside of its native dimensions.
Since we cannot read/query the metadata of a file on a user's PC directly via Lua we provide this information via the [factorio_modportal_blob.lua] and are trusting it to be up-to-date.

If you do not want any startup risk from thumbnails, use the default startup mod-setting: [No thumbnails]
Modlist UI will still use the blob’s text metadata, just without the pretty pictures.


Latest --- Why are blob updates so periodic?

Update frequency is a compromise. Mods generally don't change their title, description or thumbnail very often, but 10+ new mods appear every day. Updating Modlist UI that often would be asinine for both user and myself. Fortnightly updates with a bundled up-to-date scraped blob are boring, polite, and good enough.


Deprecated --- 3rd Party Mod Featuring (Metadata Hook)

After a lot of trial and error, now all required data such as author, title, description, and thmbnail.png fields can be directly pulled from a mod-portal scrape data blob, and from all installed mods themselves during data/prototyping, without any input/special code from the 3rd party mods.

If you created a data-updates.lua, and or other code specifically to cater for Modlist UI, you can safely remove it. Apologies for any confusion or jumping the gun.