UnmanagedMods

class mobase.UnmanagedMods

Bases: abc.ABC

Methods Summary

displayName(mod_name)

Retrieve the display name of a given mod.

mods(official_only)

Retrieve the list of unmanaged mods for the corresponding game.

referenceFile(mod_name)

Retrieve the reference file for the requested mod.

secondaryFiles(mod_name)

Retrieve the secondary files for the requested mod.

Methods Documentation

abstract displayName(mod_name)

Retrieve the display name of a given mod.

Parameters

mod_name – Internal name of the mod.

Returns

The display name of the mod.

Return type

str

abstract mods(official_only)

Retrieve the list of unmanaged mods for the corresponding game.

Parameters

official_only – Retrieve only unmanaged official mods.

Returns

The list of unmanaged mods (internal names).

Return type

List[str]

abstract referenceFile(mod_name)

Retrieve the reference file for the requested mod.

Example: For Bethesda games, the reference file may be the main plugin (esp or esm) for the game or a DLCs.

Parameters

mod_name – Internal name of the mod.

Returns

The reference file (absolute path) for the requested mod.

Return type

QFileInfo

abstract secondaryFiles(mod_name)

Retrieve the secondary files for the requested mod.

Example: For Bethesda games, the secondary files may be the archives corresponding to the reference file.

Parameters

mod_name – Internal name of the mod.

Returns

The secondary files (absolute paths) for the request mod.

Return type

List[str]