find-itch-games
    Preparing search index...

    Interface IItchLookupOptions

    Options for looking up a single game.

    interface IItchLookupOptions {
        itchPath?: string;
        strategy?: "db" | "merge" | "receipts";
        checkExists?: boolean;
        extraLibraries?: readonly string[];
        ignoreDatabase?: boolean;
        lookup?: IItchPathLookup;
        strict?: boolean;
    }

    Hierarchy (View Summary)

    Index
    itchPath? strategy? checkExists? extraLibraries? ignoreDatabase? lookup? strict?
    itchPath?: string

    Override the itch user-data directory instead of searching for it.

    strategy?: "db" | "merge" | "receipts"
    "merge"
    checkExists?: boolean

    Drop games whose install folder is gone. itch leaves caves behind when a folder is deleted outside the app, so this defaults to on.

    true
    extraLibraries?: readonly string[]

    Extra install locations to scan, e.g. a drive itch was moved off.

    ignoreDatabase?: boolean

    Don't touch butler.db at all, not even for install locations. Only preferences.json, the built-in appdata location and extraLibraries are used. Implies strategy: "receipts".

    false
    lookup?: IItchPathLookup

    Search as though for a different user, environment or operating system. Ignored when itchPath is given, which names the directory outright.

    strict?: boolean

    Throw AmbiguousAppError when more than one installed game matches, instead of returning the first. The same game can legitimately be installed in two locations, and a fuzzy name search can collide, so set this when picking the wrong one would be worse than failing.

    false

    Settings
    Member Visibility

    On This Page
    Properties