ModList

What is the Mod List (or Index)?

In Faroquin there is a file stored locally that includes the list of all mods the loader uses. This file pulls from this repo's modlist.json automatically unless disabled in the settings.

What values are in it, and what do they mean?

An example with notes

    {
        "id": "steamodded", 
        "name": "Steamodded",
        "description": "Steamodded is a mod loader and injector.",
        "github": "https://github.com/Steamodded/smods",
        "specialDownload": "https://github.com/Steamodded/smods/archive/350aff8b2cdef6d00e3b554f8ffa9d1b49728ba0.zip",
        "core": true,
        "sha": "2a3b5c28642eb4861e3557ca649ee45340fe9069",
        "etag": "\"98caa64f44de4c961511d19877b96412d70bc44f75f04e4ba65ebfd2205c5955\""
    },

ID is used by the loader to uniquely identify mods. It uses the mod's id defined in the lua header of balatro mods to distinguish locally installed mods from the browsed list.

Example id Cardsauce (MOD_ID)

--- STEAMODDED HEADER
--- MOD_NAME: Cardsauce
--- MOD_ID: Cardsauce 

• Name is the value displayed in the mod list UI of Faroquin. It should ideally be properly capitalized and punctuated.
• Description is the short description displayed in the UI. Try to avoid long descriptions.
• Github points to the github the mod is hosted on, and by default is where it downloads the latest version of a mod
• specialDownload this points to a unique download link or specific version of a mod. If this is defined it will only use that download link and will not automatically update or show updates from the mod's github
• corethis denotes mods that are loaders/injectors like steamodded or lovely. There is internal code that has to be set for these to properly be downloaded.
• sha is the latest commit hash on a github, this is used for pulling updates. You can get this from the auto-generated .faro files located in the mod folder of each specific mod after downloading them from the Browse Mods section
• etag similar to sha is generated automatically after installing a mod, this is used to check when the commits page of a github is last updated.

Required items are Name and Description, but it is preferred to have a GitHub and it would be helpful to add a generated sha and etag as this limits the requests over the github API the program uses. These periodically need to be updated as mods are updated to limit the amount of mods looking for updates over the API.

By default you get 60 requests an hour so more than 60 mods requesting without the sha or etag will prevent further requests.

You are not required to have every item like core or specialDownload listed. Many things that are generated from the program are not necessary for the main modlist.

How do I add to it?

You can modify this file by making a PR to the modlist on this repo or alternatively disabling automatic updates for it and changing the local file.
By default the application creates and stores this file in electron's app.getPath('userData')
For example on Windows C:\Users\%UserProfile%\AppData\Roaming\faroquin\modlist.json (filepath may change depending on install location)