IPluginInstallerCustom

class mobase.IPluginInstallerCustom

Bases: mobase.IPluginInstaller

Custom installer for mods. Custom installers receive the archive name and have to go from there. They have to be able to extract the archive themselves.

Example of such installers are the external NCC installer or the OMOD installer.

Methods Summary

install(mod_name, game_name, archive_name, …)

Install the given archive.

isArchiveSupported(archive_name)

Check if the given file is a supported archive for this installer.

supportedExtensions()

returns

A list of file extensions that this installer can handle.

Methods Documentation

abstract install(mod_name, game_name, archive_name, version, nexus_id)

Install the given archive.

The mod needs to be created by calling IOrganizer.createMod first.

Parameters

  • mod_name – Name of the mod to install. As an input parameter this is the suggested name (e.g. from meta data) The installer may change this parameter to rename the mod).

  • game_name – Name of the game for which the mod is installed.

  • archive_name – Name of the archive to install.

  • version – Version of the mod. May be empty if the version is not yet known. The plugin is responsible for setting the version on the created mod.

  • nexus_id – ID of the mod or -1 if unknown. The plugin is responsible for setting the mod ID for the created mod.

Returns

The result of the installation process.

Return type

InstallResult

abstract isArchiveSupported(archive_name)

Check if the given file is a supported archive for this installer.

Parameters

archive_name – Name of the archive.

Returns

True if this installer can handle the archive, False otherwise.

Return type

bool

abstract supportedExtensions()
Returns

A list of file extensions that this installer can handle.

Return type

List[str]