diff --git a/.buildinfo b/.buildinfo index 874f829..878c710 100644 --- a/.buildinfo +++ b/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 2cca5eb31870adf5b5133d4d3eea0e53 +config: 1be0a47f3974444b85d242f6e3ee6100 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.doctrees/api/mobase.BSAInvalidation.doctree b/.doctrees/api/mobase.BSAInvalidation.doctree deleted file mode 100644 index 3c3dfbf..0000000 Binary files a/.doctrees/api/mobase.BSAInvalidation.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.DataArchives.doctree b/.doctrees/api/mobase.DataArchives.doctree deleted file mode 100644 index 8467105..0000000 Binary files a/.doctrees/api/mobase.DataArchives.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.EndorsedState.doctree b/.doctrees/api/mobase.EndorsedState.doctree deleted file mode 100644 index 1440131..0000000 Binary files a/.doctrees/api/mobase.EndorsedState.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.ExecutableForcedLoadSetting.doctree b/.doctrees/api/mobase.ExecutableForcedLoadSetting.doctree deleted file mode 100644 index 131f364..0000000 Binary files a/.doctrees/api/mobase.ExecutableForcedLoadSetting.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.ExecutableInfo.doctree b/.doctrees/api/mobase.ExecutableInfo.doctree deleted file mode 100644 index 750df71..0000000 Binary files a/.doctrees/api/mobase.ExecutableInfo.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.FileInfo.doctree b/.doctrees/api/mobase.FileInfo.doctree deleted file mode 100644 index 96c4f63..0000000 Binary files a/.doctrees/api/mobase.FileInfo.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.FileTreeEntry.doctree b/.doctrees/api/mobase.FileTreeEntry.doctree deleted file mode 100644 index 97d68ff..0000000 Binary files a/.doctrees/api/mobase.FileTreeEntry.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.GameFeature.doctree b/.doctrees/api/mobase.GameFeature.doctree deleted file mode 100644 index 5b0b1aa..0000000 Binary files a/.doctrees/api/mobase.GameFeature.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.GamePlugins.doctree b/.doctrees/api/mobase.GamePlugins.doctree deleted file mode 100644 index 130949f..0000000 Binary files a/.doctrees/api/mobase.GamePlugins.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.GuessQuality.doctree b/.doctrees/api/mobase.GuessQuality.doctree deleted file mode 100644 index b999485..0000000 Binary files a/.doctrees/api/mobase.GuessQuality.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.GuessedString.doctree b/.doctrees/api/mobase.GuessedString.doctree deleted file mode 100644 index 3d6c413..0000000 Binary files a/.doctrees/api/mobase.GuessedString.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.IDownloadManager.doctree b/.doctrees/api/mobase.IDownloadManager.doctree deleted file mode 100644 index 0e15bad..0000000 Binary files a/.doctrees/api/mobase.IDownloadManager.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.IFileTree.doctree b/.doctrees/api/mobase.IFileTree.doctree deleted file mode 100644 index 61d7f1d..0000000 Binary files a/.doctrees/api/mobase.IFileTree.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.IGameFeatures.doctree b/.doctrees/api/mobase.IGameFeatures.doctree deleted file mode 100644 index 2b50443..0000000 Binary files a/.doctrees/api/mobase.IGameFeatures.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.IInstallationManager.doctree b/.doctrees/api/mobase.IInstallationManager.doctree deleted file mode 100644 index c1a3315..0000000 Binary files a/.doctrees/api/mobase.IInstallationManager.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.IModInterface.doctree b/.doctrees/api/mobase.IModInterface.doctree deleted file mode 100644 index e2b48aa..0000000 Binary files a/.doctrees/api/mobase.IModInterface.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.IModList.doctree b/.doctrees/api/mobase.IModList.doctree deleted file mode 100644 index 04c0759..0000000 Binary files a/.doctrees/api/mobase.IModList.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.IModRepositoryBridge.doctree b/.doctrees/api/mobase.IModRepositoryBridge.doctree deleted file mode 100644 index 6d62fd9..0000000 Binary files a/.doctrees/api/mobase.IModRepositoryBridge.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.IOrganizer.doctree b/.doctrees/api/mobase.IOrganizer.doctree deleted file mode 100644 index 78189b1..0000000 Binary files a/.doctrees/api/mobase.IOrganizer.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.IPlugin.doctree b/.doctrees/api/mobase.IPlugin.doctree deleted file mode 100644 index 60f9a87..0000000 Binary files a/.doctrees/api/mobase.IPlugin.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.IPluginDiagnose.doctree b/.doctrees/api/mobase.IPluginDiagnose.doctree deleted file mode 100644 index c42acb6..0000000 Binary files a/.doctrees/api/mobase.IPluginDiagnose.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.IPluginFileMapper.doctree b/.doctrees/api/mobase.IPluginFileMapper.doctree deleted file mode 100644 index e3437bf..0000000 Binary files a/.doctrees/api/mobase.IPluginFileMapper.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.IPluginGame.doctree b/.doctrees/api/mobase.IPluginGame.doctree deleted file mode 100644 index 360dadd..0000000 Binary files a/.doctrees/api/mobase.IPluginGame.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.IPluginInstaller.doctree b/.doctrees/api/mobase.IPluginInstaller.doctree deleted file mode 100644 index 914b463..0000000 Binary files a/.doctrees/api/mobase.IPluginInstaller.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.IPluginInstallerCustom.doctree b/.doctrees/api/mobase.IPluginInstallerCustom.doctree deleted file mode 100644 index 3f4cd72..0000000 Binary files a/.doctrees/api/mobase.IPluginInstallerCustom.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.IPluginInstallerSimple.doctree b/.doctrees/api/mobase.IPluginInstallerSimple.doctree deleted file mode 100644 index c9316c5..0000000 Binary files a/.doctrees/api/mobase.IPluginInstallerSimple.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.IPluginList.doctree b/.doctrees/api/mobase.IPluginList.doctree deleted file mode 100644 index cb84dbe..0000000 Binary files a/.doctrees/api/mobase.IPluginList.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.IPluginModPage.doctree b/.doctrees/api/mobase.IPluginModPage.doctree deleted file mode 100644 index df4d3d0..0000000 Binary files a/.doctrees/api/mobase.IPluginModPage.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.IPluginPreview.doctree b/.doctrees/api/mobase.IPluginPreview.doctree deleted file mode 100644 index b1d17d6..0000000 Binary files a/.doctrees/api/mobase.IPluginPreview.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.IPluginRequirement.doctree b/.doctrees/api/mobase.IPluginRequirement.doctree deleted file mode 100644 index bc8709c..0000000 Binary files a/.doctrees/api/mobase.IPluginRequirement.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.IPluginTool.doctree b/.doctrees/api/mobase.IPluginTool.doctree deleted file mode 100644 index 534bf67..0000000 Binary files a/.doctrees/api/mobase.IPluginTool.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.IProfile.doctree b/.doctrees/api/mobase.IProfile.doctree deleted file mode 100644 index 9b58313..0000000 Binary files a/.doctrees/api/mobase.IProfile.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.ISaveGame.doctree b/.doctrees/api/mobase.ISaveGame.doctree deleted file mode 100644 index 7953d14..0000000 Binary files a/.doctrees/api/mobase.ISaveGame.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.ISaveGameInfoWidget.doctree b/.doctrees/api/mobase.ISaveGameInfoWidget.doctree deleted file mode 100644 index f09754b..0000000 Binary files a/.doctrees/api/mobase.ISaveGameInfoWidget.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.InstallResult.doctree b/.doctrees/api/mobase.InstallResult.doctree deleted file mode 100644 index 0e9acf4..0000000 Binary files a/.doctrees/api/mobase.InstallResult.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.LoadOrderMechanism.doctree b/.doctrees/api/mobase.LoadOrderMechanism.doctree deleted file mode 100644 index b758df0..0000000 Binary files a/.doctrees/api/mobase.LoadOrderMechanism.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.LocalSavegames.doctree b/.doctrees/api/mobase.LocalSavegames.doctree deleted file mode 100644 index 5ff5cae..0000000 Binary files a/.doctrees/api/mobase.LocalSavegames.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.Mapping.doctree b/.doctrees/api/mobase.Mapping.doctree deleted file mode 100644 index 064f349..0000000 Binary files a/.doctrees/api/mobase.Mapping.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.ModDataChecker.doctree b/.doctrees/api/mobase.ModDataChecker.doctree deleted file mode 100644 index 00f4385..0000000 Binary files a/.doctrees/api/mobase.ModDataChecker.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.ModDataContent.doctree b/.doctrees/api/mobase.ModDataContent.doctree deleted file mode 100644 index d2dd2a9..0000000 Binary files a/.doctrees/api/mobase.ModDataContent.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.ModRepositoryFileInfo.doctree b/.doctrees/api/mobase.ModRepositoryFileInfo.doctree deleted file mode 100644 index 52fcd22..0000000 Binary files a/.doctrees/api/mobase.ModRepositoryFileInfo.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.ModState.doctree b/.doctrees/api/mobase.ModState.doctree deleted file mode 100644 index c56d43e..0000000 Binary files a/.doctrees/api/mobase.ModState.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.PluginRequirementFactory.doctree b/.doctrees/api/mobase.PluginRequirementFactory.doctree deleted file mode 100644 index c2c3ed2..0000000 Binary files a/.doctrees/api/mobase.PluginRequirementFactory.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.PluginSetting.doctree b/.doctrees/api/mobase.PluginSetting.doctree deleted file mode 100644 index d9a9dda..0000000 Binary files a/.doctrees/api/mobase.PluginSetting.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.PluginState.doctree b/.doctrees/api/mobase.PluginState.doctree deleted file mode 100644 index 037797a..0000000 Binary files a/.doctrees/api/mobase.PluginState.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.ProfileSetting.doctree b/.doctrees/api/mobase.ProfileSetting.doctree deleted file mode 100644 index 40ed526..0000000 Binary files a/.doctrees/api/mobase.ProfileSetting.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.ReleaseType.doctree b/.doctrees/api/mobase.ReleaseType.doctree deleted file mode 100644 index 5ce9619..0000000 Binary files a/.doctrees/api/mobase.ReleaseType.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.SaveGameInfo.doctree b/.doctrees/api/mobase.SaveGameInfo.doctree deleted file mode 100644 index ee3d9ee..0000000 Binary files a/.doctrees/api/mobase.SaveGameInfo.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.ScriptExtender.doctree b/.doctrees/api/mobase.ScriptExtender.doctree deleted file mode 100644 index 6f145d7..0000000 Binary files a/.doctrees/api/mobase.ScriptExtender.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.SortMechanism.doctree b/.doctrees/api/mobase.SortMechanism.doctree deleted file mode 100644 index da7e6f5..0000000 Binary files a/.doctrees/api/mobase.SortMechanism.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.TrackedState.doctree b/.doctrees/api/mobase.TrackedState.doctree deleted file mode 100644 index bff7496..0000000 Binary files a/.doctrees/api/mobase.TrackedState.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.UnmanagedMods.doctree b/.doctrees/api/mobase.UnmanagedMods.doctree deleted file mode 100644 index 83f1563..0000000 Binary files a/.doctrees/api/mobase.UnmanagedMods.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.VersionInfo.doctree b/.doctrees/api/mobase.VersionInfo.doctree deleted file mode 100644 index b493f37..0000000 Binary files a/.doctrees/api/mobase.VersionInfo.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.VersionScheme.doctree b/.doctrees/api/mobase.VersionScheme.doctree deleted file mode 100644 index 2fd7f95..0000000 Binary files a/.doctrees/api/mobase.VersionScheme.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.getFileVersion.doctree b/.doctrees/api/mobase.getFileVersion.doctree deleted file mode 100644 index 06119be..0000000 Binary files a/.doctrees/api/mobase.getFileVersion.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.getIconForExecutable.doctree b/.doctrees/api/mobase.getIconForExecutable.doctree deleted file mode 100644 index 61feee6..0000000 Binary files a/.doctrees/api/mobase.getIconForExecutable.doctree and /dev/null differ diff --git a/.doctrees/api/mobase.getProductVersion.doctree b/.doctrees/api/mobase.getProductVersion.doctree deleted file mode 100644 index 0737476..0000000 Binary files a/.doctrees/api/mobase.getProductVersion.doctree and /dev/null differ diff --git a/.doctrees/autoapi/index.doctree b/.doctrees/autoapi/index.doctree new file mode 100644 index 0000000..3571500 Binary files /dev/null and b/.doctrees/autoapi/index.doctree differ diff --git a/.doctrees/autoapi/mobase/index.doctree b/.doctrees/autoapi/mobase/index.doctree new file mode 100644 index 0000000..9ed3ac7 Binary files /dev/null and b/.doctrees/autoapi/mobase/index.doctree differ diff --git a/.doctrees/autoapi/mobase/widgets/index.doctree b/.doctrees/autoapi/mobase/widgets/index.doctree new file mode 100644 index 0000000..20c73f0 Binary files /dev/null and b/.doctrees/autoapi/mobase/widgets/index.doctree differ diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle index a8a8cb4..fbdddf6 100644 Binary files a/.doctrees/environment.pickle and b/.doctrees/environment.pickle differ diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree index edc7b22..3ab88d6 100644 Binary files a/.doctrees/index.doctree and b/.doctrees/index.doctree differ diff --git a/.doctrees/mobase.doctree b/.doctrees/mobase.doctree deleted file mode 100644 index 6a0a987..0000000 Binary files a/.doctrees/mobase.doctree and /dev/null differ diff --git a/.doctrees/modules.doctree b/.doctrees/modules.doctree deleted file mode 100644 index 7916e71..0000000 Binary files a/.doctrees/modules.doctree and /dev/null differ diff --git a/_sources/api/mobase.BSAInvalidation.rst.txt b/_sources/api/mobase.BSAInvalidation.rst.txt deleted file mode 100644 index 55572c5..0000000 --- a/_sources/api/mobase.BSAInvalidation.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -BSAInvalidation -=============== - -.. currentmodule:: mobase - -.. autoclass:: BSAInvalidation - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~BSAInvalidation.activate - ~BSAInvalidation.deactivate - ~BSAInvalidation.isInvalidationBSA - - .. rubric:: Methods Documentation - - .. automethod:: activate - .. automethod:: deactivate - .. automethod:: isInvalidationBSA diff --git a/_sources/api/mobase.DataArchives.rst.txt b/_sources/api/mobase.DataArchives.rst.txt deleted file mode 100644 index 78b501b..0000000 --- a/_sources/api/mobase.DataArchives.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -DataArchives -============ - -.. currentmodule:: mobase - -.. autoclass:: DataArchives - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~DataArchives.addArchive - ~DataArchives.archives - ~DataArchives.removeArchive - ~DataArchives.vanillaArchives - - .. rubric:: Methods Documentation - - .. automethod:: addArchive - .. automethod:: archives - .. automethod:: removeArchive - .. automethod:: vanillaArchives diff --git a/_sources/api/mobase.EndorsedState.rst.txt b/_sources/api/mobase.EndorsedState.rst.txt deleted file mode 100644 index 737efc4..0000000 --- a/_sources/api/mobase.EndorsedState.rst.txt +++ /dev/null @@ -1,27 +0,0 @@ -EndorsedState -============= - -.. currentmodule:: mobase - -.. autoclass:: EndorsedState - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~EndorsedState.ENDORSED_FALSE - ~EndorsedState.ENDORSED_NEVER - ~EndorsedState.ENDORSED_TRUE - ~EndorsedState.ENDORSED_UNKNOWN - ~EndorsedState.name - ~EndorsedState.value - - .. rubric:: Attributes Documentation - - .. autoattribute:: ENDORSED_FALSE - .. autoattribute:: ENDORSED_NEVER - .. autoattribute:: ENDORSED_TRUE - .. autoattribute:: ENDORSED_UNKNOWN - .. autoattribute:: name - .. autoattribute:: value diff --git a/_sources/api/mobase.ExecutableForcedLoadSetting.rst.txt b/_sources/api/mobase.ExecutableForcedLoadSetting.rst.txt deleted file mode 100644 index 2e5226c..0000000 --- a/_sources/api/mobase.ExecutableForcedLoadSetting.rst.txt +++ /dev/null @@ -1,27 +0,0 @@ -ExecutableForcedLoadSetting -=========================== - -.. currentmodule:: mobase - -.. autoclass:: ExecutableForcedLoadSetting - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~ExecutableForcedLoadSetting.enabled - ~ExecutableForcedLoadSetting.forced - ~ExecutableForcedLoadSetting.library - ~ExecutableForcedLoadSetting.process - ~ExecutableForcedLoadSetting.withEnabled - ~ExecutableForcedLoadSetting.withForced - - .. rubric:: Methods Documentation - - .. automethod:: enabled - .. automethod:: forced - .. automethod:: library - .. automethod:: process - .. automethod:: withEnabled - .. automethod:: withForced diff --git a/_sources/api/mobase.ExecutableInfo.rst.txt b/_sources/api/mobase.ExecutableInfo.rst.txt deleted file mode 100644 index 2588e88..0000000 --- a/_sources/api/mobase.ExecutableInfo.rst.txt +++ /dev/null @@ -1,37 +0,0 @@ -ExecutableInfo -============== - -.. currentmodule:: mobase - -.. autoclass:: ExecutableInfo - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~ExecutableInfo.arguments - ~ExecutableInfo.asCustom - ~ExecutableInfo.binary - ~ExecutableInfo.isCustom - ~ExecutableInfo.isValid - ~ExecutableInfo.steamAppID - ~ExecutableInfo.title - ~ExecutableInfo.withArgument - ~ExecutableInfo.withSteamAppId - ~ExecutableInfo.withWorkingDirectory - ~ExecutableInfo.workingDirectory - - .. rubric:: Methods Documentation - - .. automethod:: arguments - .. automethod:: asCustom - .. automethod:: binary - .. automethod:: isCustom - .. automethod:: isValid - .. automethod:: steamAppID - .. automethod:: title - .. automethod:: withArgument - .. automethod:: withSteamAppId - .. automethod:: withWorkingDirectory - .. automethod:: workingDirectory diff --git a/_sources/api/mobase.FileInfo.rst.txt b/_sources/api/mobase.FileInfo.rst.txt deleted file mode 100644 index 4fdd871..0000000 --- a/_sources/api/mobase.FileInfo.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -FileInfo -======== - -.. currentmodule:: mobase - -.. autoclass:: FileInfo - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~FileInfo.archive - ~FileInfo.filePath - ~FileInfo.origins - - .. rubric:: Attributes Documentation - - .. autoattribute:: archive - .. autoattribute:: filePath - .. autoattribute:: origins diff --git a/_sources/api/mobase.FileTreeEntry.rst.txt b/_sources/api/mobase.FileTreeEntry.rst.txt deleted file mode 100644 index 97be645..0000000 --- a/_sources/api/mobase.FileTreeEntry.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -FileTreeEntry -============= - -.. currentmodule:: mobase - -.. autoclass:: FileTreeEntry - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~FileTreeEntry.DIRECTORY - ~FileTreeEntry.FILE - ~FileTreeEntry.FILE_OR_DIRECTORY - - .. rubric:: Methods Summary - - .. autosummary:: - - ~FileTreeEntry.detach - ~FileTreeEntry.fileType - ~FileTreeEntry.hasSuffix - ~FileTreeEntry.isDir - ~FileTreeEntry.isFile - ~FileTreeEntry.moveTo - ~FileTreeEntry.name - ~FileTreeEntry.parent - ~FileTreeEntry.path - ~FileTreeEntry.pathFrom - ~FileTreeEntry.suffix - - .. rubric:: Attributes Documentation - - .. autoattribute:: DIRECTORY - .. autoattribute:: FILE - .. autoattribute:: FILE_OR_DIRECTORY - - .. rubric:: Methods Documentation - - .. automethod:: detach - .. automethod:: fileType - .. automethod:: hasSuffix - .. automethod:: isDir - .. automethod:: isFile - .. automethod:: moveTo - .. automethod:: name - .. automethod:: parent - .. automethod:: path - .. automethod:: pathFrom - .. automethod:: suffix diff --git a/_sources/api/mobase.GameFeature.rst.txt b/_sources/api/mobase.GameFeature.rst.txt deleted file mode 100644 index f75a77e..0000000 --- a/_sources/api/mobase.GameFeature.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -GameFeature -=========== - -.. currentmodule:: mobase - -.. autoclass:: GameFeature - :show-inheritance: diff --git a/_sources/api/mobase.GamePlugins.rst.txt b/_sources/api/mobase.GamePlugins.rst.txt deleted file mode 100644 index 79becea..0000000 --- a/_sources/api/mobase.GamePlugins.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -GamePlugins -=========== - -.. currentmodule:: mobase - -.. autoclass:: GamePlugins - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~GamePlugins.getLoadOrder - ~GamePlugins.lightPluginsAreSupported - ~GamePlugins.mediumPluginsAreSupported - ~GamePlugins.readPluginLists - ~GamePlugins.writePluginLists - - .. rubric:: Methods Documentation - - .. automethod:: getLoadOrder - .. automethod:: lightPluginsAreSupported - .. automethod:: mediumPluginsAreSupported - .. automethod:: readPluginLists - .. automethod:: writePluginLists diff --git a/_sources/api/mobase.GuessQuality.rst.txt b/_sources/api/mobase.GuessQuality.rst.txt deleted file mode 100644 index 66684df..0000000 --- a/_sources/api/mobase.GuessQuality.rst.txt +++ /dev/null @@ -1,31 +0,0 @@ -GuessQuality -============ - -.. currentmodule:: mobase - -.. autoclass:: GuessQuality - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~GuessQuality.FALLBACK - ~GuessQuality.GOOD - ~GuessQuality.INVALID - ~GuessQuality.META - ~GuessQuality.PRESET - ~GuessQuality.USER - ~GuessQuality.name - ~GuessQuality.value - - .. rubric:: Attributes Documentation - - .. autoattribute:: FALLBACK - .. autoattribute:: GOOD - .. autoattribute:: INVALID - .. autoattribute:: META - .. autoattribute:: PRESET - .. autoattribute:: USER - .. autoattribute:: name - .. autoattribute:: value diff --git a/_sources/api/mobase.GuessedString.rst.txt b/_sources/api/mobase.GuessedString.rst.txt deleted file mode 100644 index 6da307d..0000000 --- a/_sources/api/mobase.GuessedString.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -GuessedString -============= - -.. currentmodule:: mobase - -.. autoclass:: GuessedString - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~GuessedString.reset - ~GuessedString.setFilter - ~GuessedString.update - ~GuessedString.variants - - .. rubric:: Methods Documentation - - .. automethod:: reset - .. automethod:: setFilter - .. automethod:: update - .. automethod:: variants diff --git a/_sources/api/mobase.IDownloadManager.rst.txt b/_sources/api/mobase.IDownloadManager.rst.txt deleted file mode 100644 index 3dbc76a..0000000 --- a/_sources/api/mobase.IDownloadManager.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -IDownloadManager -================ - -.. currentmodule:: mobase - -.. autoclass:: IDownloadManager - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IDownloadManager.downloadPath - ~IDownloadManager.onDownloadComplete - ~IDownloadManager.onDownloadFailed - ~IDownloadManager.onDownloadPaused - ~IDownloadManager.onDownloadRemoved - ~IDownloadManager.startDownloadNexusFile - ~IDownloadManager.startDownloadURLs - - .. rubric:: Methods Documentation - - .. automethod:: downloadPath - .. automethod:: onDownloadComplete - .. automethod:: onDownloadFailed - .. automethod:: onDownloadPaused - .. automethod:: onDownloadRemoved - .. automethod:: startDownloadNexusFile - .. automethod:: startDownloadURLs diff --git a/_sources/api/mobase.IFileTree.rst.txt b/_sources/api/mobase.IFileTree.rst.txt deleted file mode 100644 index 92f7c9a..0000000 --- a/_sources/api/mobase.IFileTree.rst.txt +++ /dev/null @@ -1,65 +0,0 @@ -IFileTree -========= - -.. currentmodule:: mobase - -.. autoclass:: IFileTree - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~IFileTree.CONTINUE - ~IFileTree.FAIL_IF_EXISTS - ~IFileTree.MERGE - ~IFileTree.REPLACE - ~IFileTree.SKIP - ~IFileTree.STOP - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IFileTree.addDirectory - ~IFileTree.addFile - ~IFileTree.clear - ~IFileTree.copy - ~IFileTree.createOrphanTree - ~IFileTree.exists - ~IFileTree.find - ~IFileTree.insert - ~IFileTree.merge - ~IFileTree.move - ~IFileTree.pathTo - ~IFileTree.remove - ~IFileTree.removeAll - ~IFileTree.removeIf - ~IFileTree.walk - - .. rubric:: Attributes Documentation - - .. autoattribute:: CONTINUE - .. autoattribute:: FAIL_IF_EXISTS - .. autoattribute:: MERGE - .. autoattribute:: REPLACE - .. autoattribute:: SKIP - .. autoattribute:: STOP - - .. rubric:: Methods Documentation - - .. automethod:: addDirectory - .. automethod:: addFile - .. automethod:: clear - .. automethod:: copy - .. automethod:: createOrphanTree - .. automethod:: exists - .. automethod:: find - .. automethod:: insert - .. automethod:: merge - .. automethod:: move - .. automethod:: pathTo - .. automethod:: remove - .. automethod:: removeAll - .. automethod:: removeIf - .. automethod:: walk diff --git a/_sources/api/mobase.IGameFeatures.rst.txt b/_sources/api/mobase.IGameFeatures.rst.txt deleted file mode 100644 index f4155ac..0000000 --- a/_sources/api/mobase.IGameFeatures.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -IGameFeatures -============= - -.. currentmodule:: mobase - -.. autoclass:: IGameFeatures - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IGameFeatures.gameFeature - ~IGameFeatures.registerFeature - ~IGameFeatures.unregisterFeature - ~IGameFeatures.unregisterFeatures - - .. rubric:: Methods Documentation - - .. automethod:: gameFeature - .. automethod:: registerFeature - .. automethod:: unregisterFeature - .. automethod:: unregisterFeatures diff --git a/_sources/api/mobase.IInstallationManager.rst.txt b/_sources/api/mobase.IInstallationManager.rst.txt deleted file mode 100644 index 9abdf06..0000000 --- a/_sources/api/mobase.IInstallationManager.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -IInstallationManager -==================== - -.. currentmodule:: mobase - -.. autoclass:: IInstallationManager - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IInstallationManager.createFile - ~IInstallationManager.extractFile - ~IInstallationManager.extractFiles - ~IInstallationManager.getSupportedExtensions - ~IInstallationManager.installArchive - - .. rubric:: Methods Documentation - - .. automethod:: createFile - .. automethod:: extractFile - .. automethod:: extractFiles - .. automethod:: getSupportedExtensions - .. automethod:: installArchive diff --git a/_sources/api/mobase.IModInterface.rst.txt b/_sources/api/mobase.IModInterface.rst.txt deleted file mode 100644 index ac14cf5..0000000 --- a/_sources/api/mobase.IModInterface.rst.txt +++ /dev/null @@ -1,89 +0,0 @@ -IModInterface -============= - -.. currentmodule:: mobase - -.. autoclass:: IModInterface - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IModInterface.absolutePath - ~IModInterface.addCategory - ~IModInterface.addNexusCategory - ~IModInterface.categories - ~IModInterface.clearPluginSettings - ~IModInterface.color - ~IModInterface.comments - ~IModInterface.converted - ~IModInterface.endorsedState - ~IModInterface.fileTree - ~IModInterface.gameName - ~IModInterface.ignoredVersion - ~IModInterface.installationFile - ~IModInterface.isBackup - ~IModInterface.isForeign - ~IModInterface.isOverwrite - ~IModInterface.isSeparator - ~IModInterface.name - ~IModInterface.newestVersion - ~IModInterface.nexusId - ~IModInterface.notes - ~IModInterface.pluginSetting - ~IModInterface.pluginSettings - ~IModInterface.primaryCategory - ~IModInterface.removeCategory - ~IModInterface.repository - ~IModInterface.setGameName - ~IModInterface.setIsEndorsed - ~IModInterface.setNewestVersion - ~IModInterface.setNexusID - ~IModInterface.setPluginSetting - ~IModInterface.setUrl - ~IModInterface.setVersion - ~IModInterface.trackedState - ~IModInterface.url - ~IModInterface.validated - ~IModInterface.version - - .. rubric:: Methods Documentation - - .. automethod:: absolutePath - .. automethod:: addCategory - .. automethod:: addNexusCategory - .. automethod:: categories - .. automethod:: clearPluginSettings - .. automethod:: color - .. automethod:: comments - .. automethod:: converted - .. automethod:: endorsedState - .. automethod:: fileTree - .. automethod:: gameName - .. automethod:: ignoredVersion - .. automethod:: installationFile - .. automethod:: isBackup - .. automethod:: isForeign - .. automethod:: isOverwrite - .. automethod:: isSeparator - .. automethod:: name - .. automethod:: newestVersion - .. automethod:: nexusId - .. automethod:: notes - .. automethod:: pluginSetting - .. automethod:: pluginSettings - .. automethod:: primaryCategory - .. automethod:: removeCategory - .. automethod:: repository - .. automethod:: setGameName - .. automethod:: setIsEndorsed - .. automethod:: setNewestVersion - .. automethod:: setNexusID - .. automethod:: setPluginSetting - .. automethod:: setUrl - .. automethod:: setVersion - .. automethod:: trackedState - .. automethod:: url - .. automethod:: validated - .. automethod:: version diff --git a/_sources/api/mobase.IModList.rst.txt b/_sources/api/mobase.IModList.rst.txt deleted file mode 100644 index 2488fcc..0000000 --- a/_sources/api/mobase.IModList.rst.txt +++ /dev/null @@ -1,43 +0,0 @@ -IModList -======== - -.. currentmodule:: mobase - -.. autoclass:: IModList - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IModList.allMods - ~IModList.allModsByProfilePriority - ~IModList.displayName - ~IModList.getMod - ~IModList.onModInstalled - ~IModList.onModMoved - ~IModList.onModRemoved - ~IModList.onModStateChanged - ~IModList.priority - ~IModList.removeMod - ~IModList.renameMod - ~IModList.setActive - ~IModList.setPriority - ~IModList.state - - .. rubric:: Methods Documentation - - .. automethod:: allMods - .. automethod:: allModsByProfilePriority - .. automethod:: displayName - .. automethod:: getMod - .. automethod:: onModInstalled - .. automethod:: onModMoved - .. automethod:: onModRemoved - .. automethod:: onModStateChanged - .. automethod:: priority - .. automethod:: removeMod - .. automethod:: renameMod - .. automethod:: setActive - .. automethod:: setPriority - .. automethod:: state diff --git a/_sources/api/mobase.IModRepositoryBridge.rst.txt b/_sources/api/mobase.IModRepositoryBridge.rst.txt deleted file mode 100644 index 2f5240f..0000000 --- a/_sources/api/mobase.IModRepositoryBridge.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -IModRepositoryBridge -==================== - -.. currentmodule:: mobase - -.. autoclass:: IModRepositoryBridge - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~IModRepositoryBridge.descriptionAvailable - ~IModRepositoryBridge.downloadURLsAvailable - ~IModRepositoryBridge.endorsementToggled - ~IModRepositoryBridge.endorsementsAvailable - ~IModRepositoryBridge.fileInfoAvailable - ~IModRepositoryBridge.filesAvailable - ~IModRepositoryBridge.requestFailed - ~IModRepositoryBridge.trackedModsAvailable - ~IModRepositoryBridge.trackingToggled - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IModRepositoryBridge.requestDescription - ~IModRepositoryBridge.requestDownloadURL - ~IModRepositoryBridge.requestFileInfo - ~IModRepositoryBridge.requestFiles - ~IModRepositoryBridge.requestToggleEndorsement - - .. rubric:: Attributes Documentation - - .. autoattribute:: descriptionAvailable - .. autoattribute:: downloadURLsAvailable - .. autoattribute:: endorsementToggled - .. autoattribute:: endorsementsAvailable - .. autoattribute:: fileInfoAvailable - .. autoattribute:: filesAvailable - .. autoattribute:: requestFailed - .. autoattribute:: trackedModsAvailable - .. autoattribute:: trackingToggled - - .. rubric:: Methods Documentation - - .. automethod:: requestDescription - .. automethod:: requestDownloadURL - .. automethod:: requestFileInfo - .. automethod:: requestFiles - .. automethod:: requestToggleEndorsement diff --git a/_sources/api/mobase.IOrganizer.rst.txt b/_sources/api/mobase.IOrganizer.rst.txt deleted file mode 100644 index 0616bfc..0000000 --- a/_sources/api/mobase.IOrganizer.rst.txt +++ /dev/null @@ -1,105 +0,0 @@ -IOrganizer -========== - -.. currentmodule:: mobase - -.. autoclass:: IOrganizer - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IOrganizer.appVersion - ~IOrganizer.basePath - ~IOrganizer.createMod - ~IOrganizer.createNexusBridge - ~IOrganizer.downloadManager - ~IOrganizer.downloadsPath - ~IOrganizer.findFileInfos - ~IOrganizer.findFiles - ~IOrganizer.gameFeatures - ~IOrganizer.getFileOrigins - ~IOrganizer.getGame - ~IOrganizer.getPluginDataPath - ~IOrganizer.installMod - ~IOrganizer.isPluginEnabled - ~IOrganizer.listDirectories - ~IOrganizer.managedGame - ~IOrganizer.modDataChanged - ~IOrganizer.modList - ~IOrganizer.modsPath - ~IOrganizer.onAboutToRun - ~IOrganizer.onFinishedRun - ~IOrganizer.onNextRefresh - ~IOrganizer.onPluginDisabled - ~IOrganizer.onPluginEnabled - ~IOrganizer.onPluginSettingChanged - ~IOrganizer.onProfileChanged - ~IOrganizer.onProfileCreated - ~IOrganizer.onProfileRemoved - ~IOrganizer.onProfileRenamed - ~IOrganizer.onUserInterfaceInitialized - ~IOrganizer.overwritePath - ~IOrganizer.persistent - ~IOrganizer.pluginDataPath - ~IOrganizer.pluginList - ~IOrganizer.pluginSetting - ~IOrganizer.profile - ~IOrganizer.profileName - ~IOrganizer.profilePath - ~IOrganizer.refresh - ~IOrganizer.resolvePath - ~IOrganizer.setPersistent - ~IOrganizer.setPluginSetting - ~IOrganizer.startApplication - ~IOrganizer.virtualFileTree - ~IOrganizer.waitForApplication - - .. rubric:: Methods Documentation - - .. automethod:: appVersion - .. automethod:: basePath - .. automethod:: createMod - .. automethod:: createNexusBridge - .. automethod:: downloadManager - .. automethod:: downloadsPath - .. automethod:: findFileInfos - .. automethod:: findFiles - .. automethod:: gameFeatures - .. automethod:: getFileOrigins - .. automethod:: getGame - .. automethod:: getPluginDataPath - .. automethod:: installMod - .. automethod:: isPluginEnabled - .. automethod:: listDirectories - .. automethod:: managedGame - .. automethod:: modDataChanged - .. automethod:: modList - .. automethod:: modsPath - .. automethod:: onAboutToRun - .. automethod:: onFinishedRun - .. automethod:: onNextRefresh - .. automethod:: onPluginDisabled - .. automethod:: onPluginEnabled - .. automethod:: onPluginSettingChanged - .. automethod:: onProfileChanged - .. automethod:: onProfileCreated - .. automethod:: onProfileRemoved - .. automethod:: onProfileRenamed - .. automethod:: onUserInterfaceInitialized - .. automethod:: overwritePath - .. automethod:: persistent - .. automethod:: pluginDataPath - .. automethod:: pluginList - .. automethod:: pluginSetting - .. automethod:: profile - .. automethod:: profileName - .. automethod:: profilePath - .. automethod:: refresh - .. automethod:: resolvePath - .. automethod:: setPersistent - .. automethod:: setPluginSetting - .. automethod:: startApplication - .. automethod:: virtualFileTree - .. automethod:: waitForApplication diff --git a/_sources/api/mobase.IPlugin.rst.txt b/_sources/api/mobase.IPlugin.rst.txt deleted file mode 100644 index d116b06..0000000 --- a/_sources/api/mobase.IPlugin.rst.txt +++ /dev/null @@ -1,35 +0,0 @@ -IPlugin -======= - -.. currentmodule:: mobase - -.. autoclass:: IPlugin - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPlugin.author - ~IPlugin.description - ~IPlugin.enabledByDefault - ~IPlugin.init - ~IPlugin.localizedName - ~IPlugin.master - ~IPlugin.name - ~IPlugin.requirements - ~IPlugin.settings - ~IPlugin.version - - .. rubric:: Methods Documentation - - .. automethod:: author - .. automethod:: description - .. automethod:: enabledByDefault - .. automethod:: init - .. automethod:: localizedName - .. automethod:: master - .. automethod:: name - .. automethod:: requirements - .. automethod:: settings - .. automethod:: version diff --git a/_sources/api/mobase.IPluginDiagnose.rst.txt b/_sources/api/mobase.IPluginDiagnose.rst.txt deleted file mode 100644 index b8cf060..0000000 --- a/_sources/api/mobase.IPluginDiagnose.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -IPluginDiagnose -=============== - -.. currentmodule:: mobase - -.. autoclass:: IPluginDiagnose - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPluginDiagnose.activeProblems - ~IPluginDiagnose.fullDescription - ~IPluginDiagnose.hasGuidedFix - ~IPluginDiagnose.shortDescription - ~IPluginDiagnose.startGuidedFix - - .. rubric:: Methods Documentation - - .. automethod:: activeProblems - .. automethod:: fullDescription - .. automethod:: hasGuidedFix - .. automethod:: shortDescription - .. automethod:: startGuidedFix diff --git a/_sources/api/mobase.IPluginFileMapper.rst.txt b/_sources/api/mobase.IPluginFileMapper.rst.txt deleted file mode 100644 index 2915e86..0000000 --- a/_sources/api/mobase.IPluginFileMapper.rst.txt +++ /dev/null @@ -1,17 +0,0 @@ -IPluginFileMapper -================= - -.. currentmodule:: mobase - -.. autoclass:: IPluginFileMapper - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPluginFileMapper.mappings - - .. rubric:: Methods Documentation - - .. automethod:: mappings diff --git a/_sources/api/mobase.IPluginGame.rst.txt b/_sources/api/mobase.IPluginGame.rst.txt deleted file mode 100644 index 1b3f1e6..0000000 --- a/_sources/api/mobase.IPluginGame.rst.txt +++ /dev/null @@ -1,89 +0,0 @@ -IPluginGame -=========== - -.. currentmodule:: mobase - -.. autoclass:: IPluginGame - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPluginGame.CCPlugins - ~IPluginGame.DLCPlugins - ~IPluginGame.binaryName - ~IPluginGame.dataDirectory - ~IPluginGame.detectGame - ~IPluginGame.displayGameName - ~IPluginGame.documentsDirectory - ~IPluginGame.enabledPlugins - ~IPluginGame.executableForcedLoads - ~IPluginGame.executables - ~IPluginGame.gameDirectory - ~IPluginGame.gameIcon - ~IPluginGame.gameName - ~IPluginGame.gameNexusName - ~IPluginGame.gameShortName - ~IPluginGame.gameVariants - ~IPluginGame.gameVersion - ~IPluginGame.getLauncherName - ~IPluginGame.getSupportURL - ~IPluginGame.iniFiles - ~IPluginGame.initializeProfile - ~IPluginGame.isInstalled - ~IPluginGame.listSaves - ~IPluginGame.loadOrderMechanism - ~IPluginGame.looksValid - ~IPluginGame.lootGameName - ~IPluginGame.nexusGameID - ~IPluginGame.nexusModOrganizerID - ~IPluginGame.primaryPlugins - ~IPluginGame.primarySources - ~IPluginGame.savesDirectory - ~IPluginGame.secondaryDataDirectories - ~IPluginGame.setGamePath - ~IPluginGame.setGameVariant - ~IPluginGame.sortMechanism - ~IPluginGame.steamAPPId - ~IPluginGame.validShortNames - - .. rubric:: Methods Documentation - - .. automethod:: CCPlugins - .. automethod:: DLCPlugins - .. automethod:: binaryName - .. automethod:: dataDirectory - .. automethod:: detectGame - .. automethod:: displayGameName - .. automethod:: documentsDirectory - .. automethod:: enabledPlugins - .. automethod:: executableForcedLoads - .. automethod:: executables - .. automethod:: gameDirectory - .. automethod:: gameIcon - .. automethod:: gameName - .. automethod:: gameNexusName - .. automethod:: gameShortName - .. automethod:: gameVariants - .. automethod:: gameVersion - .. automethod:: getLauncherName - .. automethod:: getSupportURL - .. automethod:: iniFiles - .. automethod:: initializeProfile - .. automethod:: isInstalled - .. automethod:: listSaves - .. automethod:: loadOrderMechanism - .. automethod:: looksValid - .. automethod:: lootGameName - .. automethod:: nexusGameID - .. automethod:: nexusModOrganizerID - .. automethod:: primaryPlugins - .. automethod:: primarySources - .. automethod:: savesDirectory - .. automethod:: secondaryDataDirectories - .. automethod:: setGamePath - .. automethod:: setGameVariant - .. automethod:: sortMechanism - .. automethod:: steamAPPId - .. automethod:: validShortNames diff --git a/_sources/api/mobase.IPluginInstaller.rst.txt b/_sources/api/mobase.IPluginInstaller.rst.txt deleted file mode 100644 index e176c83..0000000 --- a/_sources/api/mobase.IPluginInstaller.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -IPluginInstaller -================ - -.. currentmodule:: mobase - -.. autoclass:: IPluginInstaller - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPluginInstaller.isArchiveSupported - ~IPluginInstaller.isManualInstaller - ~IPluginInstaller.onInstallationEnd - ~IPluginInstaller.onInstallationStart - ~IPluginInstaller.priority - ~IPluginInstaller.setInstallationManager - ~IPluginInstaller.setParentWidget - - .. rubric:: Methods Documentation - - .. automethod:: isArchiveSupported - .. automethod:: isManualInstaller - .. automethod:: onInstallationEnd - .. automethod:: onInstallationStart - .. automethod:: priority - .. automethod:: setInstallationManager - .. automethod:: setParentWidget diff --git a/_sources/api/mobase.IPluginInstallerCustom.rst.txt b/_sources/api/mobase.IPluginInstallerCustom.rst.txt deleted file mode 100644 index ecffac2..0000000 --- a/_sources/api/mobase.IPluginInstallerCustom.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -IPluginInstallerCustom -====================== - -.. currentmodule:: mobase - -.. autoclass:: IPluginInstallerCustom - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPluginInstallerCustom.install - ~IPluginInstallerCustom.isArchiveSupported - ~IPluginInstallerCustom.supportedExtensions - - .. rubric:: Methods Documentation - - .. automethod:: install - .. automethod:: isArchiveSupported - .. automethod:: supportedExtensions diff --git a/_sources/api/mobase.IPluginInstallerSimple.rst.txt b/_sources/api/mobase.IPluginInstallerSimple.rst.txt deleted file mode 100644 index 328732e..0000000 --- a/_sources/api/mobase.IPluginInstallerSimple.rst.txt +++ /dev/null @@ -1,17 +0,0 @@ -IPluginInstallerSimple -====================== - -.. currentmodule:: mobase - -.. autoclass:: IPluginInstallerSimple - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPluginInstallerSimple.install - - .. rubric:: Methods Documentation - - .. automethod:: install diff --git a/_sources/api/mobase.IPluginList.rst.txt b/_sources/api/mobase.IPluginList.rst.txt deleted file mode 100644 index b7df4d3..0000000 --- a/_sources/api/mobase.IPluginList.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -IPluginList -=========== - -.. currentmodule:: mobase - -.. autoclass:: IPluginList - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPluginList.hasLightExtension - ~IPluginList.hasMasterExtension - ~IPluginList.hasNoRecords - ~IPluginList.isLightFlagged - ~IPluginList.isMasterFlagged - ~IPluginList.isMediumFlagged - ~IPluginList.loadOrder - ~IPluginList.masters - ~IPluginList.onPluginMoved - ~IPluginList.onPluginStateChanged - ~IPluginList.onRefreshed - ~IPluginList.origin - ~IPluginList.pluginNames - ~IPluginList.priority - ~IPluginList.setLoadOrder - ~IPluginList.setPriority - ~IPluginList.setState - ~IPluginList.state - - .. rubric:: Methods Documentation - - .. automethod:: hasLightExtension - .. automethod:: hasMasterExtension - .. automethod:: hasNoRecords - .. automethod:: isLightFlagged - .. automethod:: isMasterFlagged - .. automethod:: isMediumFlagged - .. automethod:: loadOrder - .. automethod:: masters - .. automethod:: onPluginMoved - .. automethod:: onPluginStateChanged - .. automethod:: onRefreshed - .. automethod:: origin - .. automethod:: pluginNames - .. automethod:: priority - .. automethod:: setLoadOrder - .. automethod:: setPriority - .. automethod:: setState - .. automethod:: state diff --git a/_sources/api/mobase.IPluginModPage.rst.txt b/_sources/api/mobase.IPluginModPage.rst.txt deleted file mode 100644 index 4ca98f7..0000000 --- a/_sources/api/mobase.IPluginModPage.rst.txt +++ /dev/null @@ -1,27 +0,0 @@ -IPluginModPage -============== - -.. currentmodule:: mobase - -.. autoclass:: IPluginModPage - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPluginModPage.displayName - ~IPluginModPage.handlesDownload - ~IPluginModPage.icon - ~IPluginModPage.pageURL - ~IPluginModPage.setParentWidget - ~IPluginModPage.useIntegratedBrowser - - .. rubric:: Methods Documentation - - .. automethod:: displayName - .. automethod:: handlesDownload - .. automethod:: icon - .. automethod:: pageURL - .. automethod:: setParentWidget - .. automethod:: useIntegratedBrowser diff --git a/_sources/api/mobase.IPluginPreview.rst.txt b/_sources/api/mobase.IPluginPreview.rst.txt deleted file mode 100644 index 8c1ddb3..0000000 --- a/_sources/api/mobase.IPluginPreview.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -IPluginPreview -============== - -.. currentmodule:: mobase - -.. autoclass:: IPluginPreview - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPluginPreview.genDataPreview - ~IPluginPreview.genFilePreview - ~IPluginPreview.supportedExtensions - ~IPluginPreview.supportsArchives - - .. rubric:: Methods Documentation - - .. automethod:: genDataPreview - .. automethod:: genFilePreview - .. automethod:: supportedExtensions - .. automethod:: supportsArchives diff --git a/_sources/api/mobase.IPluginRequirement.rst.txt b/_sources/api/mobase.IPluginRequirement.rst.txt deleted file mode 100644 index 672359b..0000000 --- a/_sources/api/mobase.IPluginRequirement.rst.txt +++ /dev/null @@ -1,17 +0,0 @@ -IPluginRequirement -================== - -.. currentmodule:: mobase - -.. autoclass:: IPluginRequirement - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPluginRequirement.check - - .. rubric:: Methods Documentation - - .. automethod:: check diff --git a/_sources/api/mobase.IPluginTool.rst.txt b/_sources/api/mobase.IPluginTool.rst.txt deleted file mode 100644 index 56265fe..0000000 --- a/_sources/api/mobase.IPluginTool.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -IPluginTool -=========== - -.. currentmodule:: mobase - -.. autoclass:: IPluginTool - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IPluginTool.display - ~IPluginTool.displayName - ~IPluginTool.icon - ~IPluginTool.setParentWidget - ~IPluginTool.tooltip - - .. rubric:: Methods Documentation - - .. automethod:: display - .. automethod:: displayName - .. automethod:: icon - .. automethod:: setParentWidget - .. automethod:: tooltip diff --git a/_sources/api/mobase.IProfile.rst.txt b/_sources/api/mobase.IProfile.rst.txt deleted file mode 100644 index 7856d3c..0000000 --- a/_sources/api/mobase.IProfile.rst.txt +++ /dev/null @@ -1,27 +0,0 @@ -IProfile -======== - -.. currentmodule:: mobase - -.. autoclass:: IProfile - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~IProfile.absoluteIniFilePath - ~IProfile.absolutePath - ~IProfile.invalidationActive - ~IProfile.localSavesEnabled - ~IProfile.localSettingsEnabled - ~IProfile.name - - .. rubric:: Methods Documentation - - .. automethod:: absoluteIniFilePath - .. automethod:: absolutePath - .. automethod:: invalidationActive - .. automethod:: localSavesEnabled - .. automethod:: localSettingsEnabled - .. automethod:: name diff --git a/_sources/api/mobase.ISaveGame.rst.txt b/_sources/api/mobase.ISaveGame.rst.txt deleted file mode 100644 index c131adc..0000000 --- a/_sources/api/mobase.ISaveGame.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -ISaveGame -========= - -.. currentmodule:: mobase - -.. autoclass:: ISaveGame - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~ISaveGame.allFiles - ~ISaveGame.getCreationTime - ~ISaveGame.getFilepath - ~ISaveGame.getName - ~ISaveGame.getSaveGroupIdentifier - - .. rubric:: Methods Documentation - - .. automethod:: allFiles - .. automethod:: getCreationTime - .. automethod:: getFilepath - .. automethod:: getName - .. automethod:: getSaveGroupIdentifier diff --git a/_sources/api/mobase.ISaveGameInfoWidget.rst.txt b/_sources/api/mobase.ISaveGameInfoWidget.rst.txt deleted file mode 100644 index 6b32d9f..0000000 --- a/_sources/api/mobase.ISaveGameInfoWidget.rst.txt +++ /dev/null @@ -1,17 +0,0 @@ -ISaveGameInfoWidget -=================== - -.. currentmodule:: mobase - -.. autoclass:: ISaveGameInfoWidget - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~ISaveGameInfoWidget.setSave - - .. rubric:: Methods Documentation - - .. automethod:: setSave diff --git a/_sources/api/mobase.InstallResult.rst.txt b/_sources/api/mobase.InstallResult.rst.txt deleted file mode 100644 index 495f82a..0000000 --- a/_sources/api/mobase.InstallResult.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -InstallResult -============= - -.. currentmodule:: mobase - -.. autoclass:: InstallResult - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~InstallResult.CANCELED - ~InstallResult.FAILED - ~InstallResult.MANUAL_REQUESTED - ~InstallResult.NOT_ATTEMPTED - ~InstallResult.SUCCESS - ~InstallResult.name - ~InstallResult.value - - .. rubric:: Attributes Documentation - - .. autoattribute:: CANCELED - .. autoattribute:: FAILED - .. autoattribute:: MANUAL_REQUESTED - .. autoattribute:: NOT_ATTEMPTED - .. autoattribute:: SUCCESS - .. autoattribute:: name - .. autoattribute:: value diff --git a/_sources/api/mobase.LoadOrderMechanism.rst.txt b/_sources/api/mobase.LoadOrderMechanism.rst.txt deleted file mode 100644 index 6179f33..0000000 --- a/_sources/api/mobase.LoadOrderMechanism.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -LoadOrderMechanism -================== - -.. currentmodule:: mobase - -.. autoclass:: LoadOrderMechanism - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~LoadOrderMechanism.FILE_TIME - ~LoadOrderMechanism.NONE - ~LoadOrderMechanism.PLUGINS_TXT - ~LoadOrderMechanism.name - ~LoadOrderMechanism.value - - .. rubric:: Attributes Documentation - - .. autoattribute:: FILE_TIME - .. autoattribute:: NONE - .. autoattribute:: PLUGINS_TXT - .. autoattribute:: name - .. autoattribute:: value diff --git a/_sources/api/mobase.LocalSavegames.rst.txt b/_sources/api/mobase.LocalSavegames.rst.txt deleted file mode 100644 index 1d8b445..0000000 --- a/_sources/api/mobase.LocalSavegames.rst.txt +++ /dev/null @@ -1,19 +0,0 @@ -LocalSavegames -============== - -.. currentmodule:: mobase - -.. autoclass:: LocalSavegames - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~LocalSavegames.mappings - ~LocalSavegames.prepareProfile - - .. rubric:: Methods Documentation - - .. automethod:: mappings - .. automethod:: prepareProfile diff --git a/_sources/api/mobase.Mapping.rst.txt b/_sources/api/mobase.Mapping.rst.txt deleted file mode 100644 index 0c628ee..0000000 --- a/_sources/api/mobase.Mapping.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -Mapping -======= - -.. currentmodule:: mobase - -.. autoclass:: Mapping - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~Mapping.createTarget - ~Mapping.destination - ~Mapping.isDirectory - ~Mapping.source - - .. rubric:: Attributes Documentation - - .. autoattribute:: createTarget - .. autoattribute:: destination - .. autoattribute:: isDirectory - .. autoattribute:: source diff --git a/_sources/api/mobase.ModDataChecker.rst.txt b/_sources/api/mobase.ModDataChecker.rst.txt deleted file mode 100644 index 25b7c55..0000000 --- a/_sources/api/mobase.ModDataChecker.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -ModDataChecker -============== - -.. currentmodule:: mobase - -.. autoclass:: ModDataChecker - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~ModDataChecker.FIXABLE - ~ModDataChecker.INVALID - ~ModDataChecker.VALID - - .. rubric:: Methods Summary - - .. autosummary:: - - ~ModDataChecker.dataLooksValid - ~ModDataChecker.fix - - .. rubric:: Attributes Documentation - - .. autoattribute:: FIXABLE - .. autoattribute:: INVALID - .. autoattribute:: VALID - - .. rubric:: Methods Documentation - - .. automethod:: dataLooksValid - .. automethod:: fix diff --git a/_sources/api/mobase.ModDataContent.rst.txt b/_sources/api/mobase.ModDataContent.rst.txt deleted file mode 100644 index 3860c13..0000000 --- a/_sources/api/mobase.ModDataContent.rst.txt +++ /dev/null @@ -1,19 +0,0 @@ -ModDataContent -============== - -.. currentmodule:: mobase - -.. autoclass:: ModDataContent - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~ModDataContent.getAllContents - ~ModDataContent.getContentsFor - - .. rubric:: Methods Documentation - - .. automethod:: getAllContents - .. automethod:: getContentsFor diff --git a/_sources/api/mobase.ModRepositoryFileInfo.rst.txt b/_sources/api/mobase.ModRepositoryFileInfo.rst.txt deleted file mode 100644 index 20710c0..0000000 --- a/_sources/api/mobase.ModRepositoryFileInfo.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ModRepositoryFileInfo -===================== - -.. currentmodule:: mobase - -.. autoclass:: ModRepositoryFileInfo - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~ModRepositoryFileInfo.categoryID - ~ModRepositoryFileInfo.description - ~ModRepositoryFileInfo.fileCategory - ~ModRepositoryFileInfo.fileID - ~ModRepositoryFileInfo.fileName - ~ModRepositoryFileInfo.fileSize - ~ModRepositoryFileInfo.fileTime - ~ModRepositoryFileInfo.gameName - ~ModRepositoryFileInfo.modID - ~ModRepositoryFileInfo.modName - ~ModRepositoryFileInfo.name - ~ModRepositoryFileInfo.newestVersion - ~ModRepositoryFileInfo.repository - ~ModRepositoryFileInfo.uri - ~ModRepositoryFileInfo.userData - ~ModRepositoryFileInfo.version - - .. rubric:: Methods Summary - - .. autosummary:: - - ~ModRepositoryFileInfo.createFromJson - - .. rubric:: Attributes Documentation - - .. autoattribute:: categoryID - .. autoattribute:: description - .. autoattribute:: fileCategory - .. autoattribute:: fileID - .. autoattribute:: fileName - .. autoattribute:: fileSize - .. autoattribute:: fileTime - .. autoattribute:: gameName - .. autoattribute:: modID - .. autoattribute:: modName - .. autoattribute:: name - .. autoattribute:: newestVersion - .. autoattribute:: repository - .. autoattribute:: uri - .. autoattribute:: userData - .. autoattribute:: version - - .. rubric:: Methods Documentation - - .. automethod:: createFromJson diff --git a/_sources/api/mobase.ModState.rst.txt b/_sources/api/mobase.ModState.rst.txt deleted file mode 100644 index 61206ee..0000000 --- a/_sources/api/mobase.ModState.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -ModState -======== - -.. currentmodule:: mobase - -.. autoclass:: ModState - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~ModState.ACTIVE - ~ModState.ALTERNATE - ~ModState.EMPTY - ~ModState.ENDORSED - ~ModState.ESSENTIAL - ~ModState.EXISTS - ~ModState.VALID - ~ModState.name - ~ModState.value - - .. rubric:: Attributes Documentation - - .. autoattribute:: ACTIVE - .. autoattribute:: ALTERNATE - .. autoattribute:: EMPTY - .. autoattribute:: ENDORSED - .. autoattribute:: ESSENTIAL - .. autoattribute:: EXISTS - .. autoattribute:: VALID - .. autoattribute:: name - .. autoattribute:: value diff --git a/_sources/api/mobase.PluginRequirementFactory.rst.txt b/_sources/api/mobase.PluginRequirementFactory.rst.txt deleted file mode 100644 index 4c3c0bb..0000000 --- a/_sources/api/mobase.PluginRequirementFactory.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -PluginRequirementFactory -======================== - -.. currentmodule:: mobase - -.. autoclass:: PluginRequirementFactory - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~PluginRequirementFactory.basic - ~PluginRequirementFactory.diagnose - ~PluginRequirementFactory.gameDependency - ~PluginRequirementFactory.pluginDependency - - .. rubric:: Methods Documentation - - .. automethod:: basic - .. automethod:: diagnose - .. automethod:: gameDependency - .. automethod:: pluginDependency diff --git a/_sources/api/mobase.PluginSetting.rst.txt b/_sources/api/mobase.PluginSetting.rst.txt deleted file mode 100644 index 2c0ab21..0000000 --- a/_sources/api/mobase.PluginSetting.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -PluginSetting -============= - -.. currentmodule:: mobase - -.. autoclass:: PluginSetting - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~PluginSetting.default_value - ~PluginSetting.description - ~PluginSetting.key - - .. rubric:: Attributes Documentation - - .. autoattribute:: default_value - .. autoattribute:: description - .. autoattribute:: key diff --git a/_sources/api/mobase.PluginState.rst.txt b/_sources/api/mobase.PluginState.rst.txt deleted file mode 100644 index 53e4481..0000000 --- a/_sources/api/mobase.PluginState.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -PluginState -=========== - -.. currentmodule:: mobase - -.. autoclass:: PluginState - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~PluginState.ACTIVE - ~PluginState.INACTIVE - ~PluginState.MISSING - ~PluginState.name - ~PluginState.value - - .. rubric:: Attributes Documentation - - .. autoattribute:: ACTIVE - .. autoattribute:: INACTIVE - .. autoattribute:: MISSING - .. autoattribute:: name - .. autoattribute:: value diff --git a/_sources/api/mobase.ProfileSetting.rst.txt b/_sources/api/mobase.ProfileSetting.rst.txt deleted file mode 100644 index 6d17925..0000000 --- a/_sources/api/mobase.ProfileSetting.rst.txt +++ /dev/null @@ -1,27 +0,0 @@ -ProfileSetting -============== - -.. currentmodule:: mobase - -.. autoclass:: ProfileSetting - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~ProfileSetting.CONFIGURATION - ~ProfileSetting.MODS - ~ProfileSetting.PREFER_DEFAULTS - ~ProfileSetting.SAVEGAMES - ~ProfileSetting.name - ~ProfileSetting.value - - .. rubric:: Attributes Documentation - - .. autoattribute:: CONFIGURATION - .. autoattribute:: MODS - .. autoattribute:: PREFER_DEFAULTS - .. autoattribute:: SAVEGAMES - .. autoattribute:: name - .. autoattribute:: value diff --git a/_sources/api/mobase.ReleaseType.rst.txt b/_sources/api/mobase.ReleaseType.rst.txt deleted file mode 100644 index 38a797a..0000000 --- a/_sources/api/mobase.ReleaseType.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -ReleaseType -=========== - -.. currentmodule:: mobase - -.. autoclass:: ReleaseType - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~ReleaseType.ALPHA - ~ReleaseType.BETA - ~ReleaseType.CANDIDATE - ~ReleaseType.FINAL - ~ReleaseType.PRE_ALPHA - ~ReleaseType.name - ~ReleaseType.value - - .. rubric:: Attributes Documentation - - .. autoattribute:: ALPHA - .. autoattribute:: BETA - .. autoattribute:: CANDIDATE - .. autoattribute:: FINAL - .. autoattribute:: PRE_ALPHA - .. autoattribute:: name - .. autoattribute:: value diff --git a/_sources/api/mobase.SaveGameInfo.rst.txt b/_sources/api/mobase.SaveGameInfo.rst.txt deleted file mode 100644 index 8efd71f..0000000 --- a/_sources/api/mobase.SaveGameInfo.rst.txt +++ /dev/null @@ -1,19 +0,0 @@ -SaveGameInfo -============ - -.. currentmodule:: mobase - -.. autoclass:: SaveGameInfo - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~SaveGameInfo.getMissingAssets - ~SaveGameInfo.getSaveGameWidget - - .. rubric:: Methods Documentation - - .. automethod:: getMissingAssets - .. automethod:: getSaveGameWidget diff --git a/_sources/api/mobase.ScriptExtender.rst.txt b/_sources/api/mobase.ScriptExtender.rst.txt deleted file mode 100644 index 665655e..0000000 --- a/_sources/api/mobase.ScriptExtender.rst.txt +++ /dev/null @@ -1,31 +0,0 @@ -ScriptExtender -============== - -.. currentmodule:: mobase - -.. autoclass:: ScriptExtender - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~ScriptExtender.binaryName - ~ScriptExtender.getArch - ~ScriptExtender.getExtenderVersion - ~ScriptExtender.isInstalled - ~ScriptExtender.loaderName - ~ScriptExtender.loaderPath - ~ScriptExtender.pluginPath - ~ScriptExtender.savegameExtension - - .. rubric:: Methods Documentation - - .. automethod:: binaryName - .. automethod:: getArch - .. automethod:: getExtenderVersion - .. automethod:: isInstalled - .. automethod:: loaderName - .. automethod:: loaderPath - .. automethod:: pluginPath - .. automethod:: savegameExtension diff --git a/_sources/api/mobase.SortMechanism.rst.txt b/_sources/api/mobase.SortMechanism.rst.txt deleted file mode 100644 index 9c5d505..0000000 --- a/_sources/api/mobase.SortMechanism.rst.txt +++ /dev/null @@ -1,27 +0,0 @@ -SortMechanism -============= - -.. currentmodule:: mobase - -.. autoclass:: SortMechanism - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~SortMechanism.BOSS - ~SortMechanism.LOOT - ~SortMechanism.MLOX - ~SortMechanism.NONE - ~SortMechanism.name - ~SortMechanism.value - - .. rubric:: Attributes Documentation - - .. autoattribute:: BOSS - .. autoattribute:: LOOT - .. autoattribute:: MLOX - .. autoattribute:: NONE - .. autoattribute:: name - .. autoattribute:: value diff --git a/_sources/api/mobase.TrackedState.rst.txt b/_sources/api/mobase.TrackedState.rst.txt deleted file mode 100644 index b3467f6..0000000 --- a/_sources/api/mobase.TrackedState.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -TrackedState -============ - -.. currentmodule:: mobase - -.. autoclass:: TrackedState - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~TrackedState.TRACKED_FALSE - ~TrackedState.TRACKED_TRUE - ~TrackedState.TRACKED_UNKNOWN - ~TrackedState.name - ~TrackedState.value - - .. rubric:: Attributes Documentation - - .. autoattribute:: TRACKED_FALSE - .. autoattribute:: TRACKED_TRUE - .. autoattribute:: TRACKED_UNKNOWN - .. autoattribute:: name - .. autoattribute:: value diff --git a/_sources/api/mobase.UnmanagedMods.rst.txt b/_sources/api/mobase.UnmanagedMods.rst.txt deleted file mode 100644 index fde652a..0000000 --- a/_sources/api/mobase.UnmanagedMods.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -UnmanagedMods -============= - -.. currentmodule:: mobase - -.. autoclass:: UnmanagedMods - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~UnmanagedMods.displayName - ~UnmanagedMods.mods - ~UnmanagedMods.referenceFile - ~UnmanagedMods.secondaryFiles - - .. rubric:: Methods Documentation - - .. automethod:: displayName - .. automethod:: mods - .. automethod:: referenceFile - .. automethod:: secondaryFiles diff --git a/_sources/api/mobase.VersionInfo.rst.txt b/_sources/api/mobase.VersionInfo.rst.txt deleted file mode 100644 index a7f32f7..0000000 --- a/_sources/api/mobase.VersionInfo.rst.txt +++ /dev/null @@ -1,27 +0,0 @@ -VersionInfo -=========== - -.. currentmodule:: mobase - -.. autoclass:: VersionInfo - :show-inheritance: - - .. rubric:: Methods Summary - - .. autosummary:: - - ~VersionInfo.canonicalString - ~VersionInfo.clear - ~VersionInfo.displayString - ~VersionInfo.isValid - ~VersionInfo.parse - ~VersionInfo.scheme - - .. rubric:: Methods Documentation - - .. automethod:: canonicalString - .. automethod:: clear - .. automethod:: displayString - .. automethod:: isValid - .. automethod:: parse - .. automethod:: scheme diff --git a/_sources/api/mobase.VersionScheme.rst.txt b/_sources/api/mobase.VersionScheme.rst.txt deleted file mode 100644 index 8e012c7..0000000 --- a/_sources/api/mobase.VersionScheme.rst.txt +++ /dev/null @@ -1,31 +0,0 @@ -VersionScheme -============= - -.. currentmodule:: mobase - -.. autoclass:: VersionScheme - :show-inheritance: - - .. rubric:: Attributes Summary - - .. autosummary:: - - ~VersionScheme.DATE - ~VersionScheme.DECIMAL_MARK - ~VersionScheme.DISCOVER - ~VersionScheme.LITERAL - ~VersionScheme.NUMBERS_AND_LETTERS - ~VersionScheme.REGULAR - ~VersionScheme.name - ~VersionScheme.value - - .. rubric:: Attributes Documentation - - .. autoattribute:: DATE - .. autoattribute:: DECIMAL_MARK - .. autoattribute:: DISCOVER - .. autoattribute:: LITERAL - .. autoattribute:: NUMBERS_AND_LETTERS - .. autoattribute:: REGULAR - .. autoattribute:: name - .. autoattribute:: value diff --git a/_sources/api/mobase.getFileVersion.rst.txt b/_sources/api/mobase.getFileVersion.rst.txt deleted file mode 100644 index 06ee694..0000000 --- a/_sources/api/mobase.getFileVersion.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -getFileVersion -============== - -.. currentmodule:: mobase - -.. autofunction:: getFileVersion diff --git a/_sources/api/mobase.getIconForExecutable.rst.txt b/_sources/api/mobase.getIconForExecutable.rst.txt deleted file mode 100644 index f7ad7e7..0000000 --- a/_sources/api/mobase.getIconForExecutable.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -getIconForExecutable -==================== - -.. currentmodule:: mobase - -.. autofunction:: getIconForExecutable diff --git a/_sources/api/mobase.getProductVersion.rst.txt b/_sources/api/mobase.getProductVersion.rst.txt deleted file mode 100644 index a5bba5c..0000000 --- a/_sources/api/mobase.getProductVersion.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -getProductVersion -================= - -.. currentmodule:: mobase - -.. autofunction:: getProductVersion diff --git a/_sources/autoapi/index.rst.txt b/_sources/autoapi/index.rst.txt new file mode 100644 index 0000000..c81f322 --- /dev/null +++ b/_sources/autoapi/index.rst.txt @@ -0,0 +1,11 @@ +API Reference +============= + +This page contains auto-generated API reference documentation [#f1]_. + +.. toctree:: + :titlesonly: + + /autoapi/mobase/index + +.. [#f1] Created with `sphinx-autoapi `_ \ No newline at end of file diff --git a/_sources/autoapi/mobase/index.rst.txt b/_sources/autoapi/mobase/index.rst.txt new file mode 100644 index 0000000..6e84bc9 --- /dev/null +++ b/_sources/autoapi/mobase/index.rst.txt @@ -0,0 +1,5766 @@ +mobase +====== + +.. py:module:: mobase + + +Subpackages +----------- + +.. toctree:: + :maxdepth: 1 + + /autoapi/mobase/widgets/index + + +Attributes +---------- + +.. autoapisummary:: + + mobase.GameFeatureType + mobase.INVALID_HANDLE_VALUE + mobase.MoVariant + mobase.__version__ + + +Classes +------- + +.. autoapisummary:: + + mobase.BSAInvalidation + mobase.DataArchives + mobase.EndorsedState + mobase.ExecutableForcedLoadSetting + mobase.ExecutableInfo + mobase.FileInfo + mobase.FileTreeEntry + mobase.GameFeature + mobase.GamePlugins + mobase.GuessQuality + mobase.GuessedString + mobase.IDownloadManager + mobase.IFileTree + mobase.IGameFeatures + mobase.IInstallationManager + mobase.IModInterface + mobase.IModList + mobase.IModRepositoryBridge + mobase.IOrganizer + mobase.IPlugin + mobase.IPluginDiagnose + mobase.IPluginFileMapper + mobase.IPluginGame + mobase.IPluginInstaller + mobase.IPluginInstallerCustom + mobase.IPluginInstallerSimple + mobase.IPluginList + mobase.IPluginModPage + mobase.IPluginPreview + mobase.IPluginRequirement + mobase.IPluginTool + mobase.IProfile + mobase.ISaveGame + mobase.ISaveGameInfoWidget + mobase.InstallResult + mobase.LoadOrderMechanism + mobase.LocalSavegames + mobase.Mapping + mobase.ModDataChecker + mobase.ModDataContent + mobase.ModRepositoryFileInfo + mobase.ModState + mobase.PluginRequirementFactory + mobase.PluginSetting + mobase.PluginState + mobase.ProfileSetting + mobase.ReleaseType + mobase.SaveGameInfo + mobase.ScriptExtender + mobase.SortMechanism + mobase.TrackedState + mobase.UnmanagedMods + mobase.VersionInfo + mobase.VersionScheme + + +Functions +--------- + +.. autoapisummary:: + + mobase.getFileVersion + mobase.getIconForExecutable + mobase.getProductVersion + + +Package Contents +---------------- + +.. py:class:: BSAInvalidation + + Bases: :py:obj:`GameFeature` + + + Base class for all game features, cannot be inherited, used only for typing + purpose in Python. + + + .. py:method:: activate(profile: IProfile) -> None + :abstractmethod: + + + + .. py:method:: deactivate(profile: IProfile) -> None + :abstractmethod: + + + + .. py:method:: isInvalidationBSA(name: str) -> bool + :abstractmethod: + + + +.. py:class:: DataArchives + + Bases: :py:obj:`GameFeature` + + + Base class for all game features, cannot be inherited, used only for typing + purpose in Python. + + + .. py:method:: addArchive(profile: IProfile, index: int, name: str) -> None + :abstractmethod: + + + Add an archive to the archive list. + + :param profile: Profile to add the archive to. + :param index: Index to insert before. Use 0 for the beginning of the list or INT_MAX for + the end of the list). + :param name: Name of the archive to add. + + + + .. py:method:: archives(profile: IProfile) -> Sequence[str] + :abstractmethod: + + + Retrieve the list of archives in the given profile. + + :param profile: Profile to retrieve archives from. + + :returns: The list of archives in the given profile. + + + + .. py:method:: removeArchive(profile: IProfile, name: str) -> None + :abstractmethod: + + + Remove the given archive from the given profile. + + :param profile: Profile to remove the archive from. + :param name: Name of the archive to remove. + + + + .. py:method:: vanillaArchives() -> Sequence[str] + :abstractmethod: + + + Retrieve the list of vanilla archives. + + Vanilla archives are archive files that are shipped with the original + game. + + :returns: The list of vanilla archives. + + + +.. py:class:: EndorsedState(*args, **kwds) + + Bases: :py:obj:`enum.Enum` + + + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + + + .. py:method:: __eq__(other: object) -> bool + + Return self==value. + + + + .. py:method:: __ge__(other: EndorsedState) -> bool + + Return self>=value. + + + + .. py:method:: __gt__(other: EndorsedState) -> bool + + Return self>value. + + + + .. py:method:: __int__() -> int + + + .. py:method:: __le__(other: EndorsedState) -> bool + + Return self<=value. + + + + .. py:method:: __lt__(other: EndorsedState) -> bool + + Return self bool + + Return self!=value. + + + + .. py:method:: __str__() -> str + + Return str(self). + + + + .. py:attribute:: ENDORSED_FALSE + :value: Ellipsis + + + + .. py:attribute:: ENDORSED_NEVER + :value: Ellipsis + + + + .. py:attribute:: ENDORSED_TRUE + :value: Ellipsis + + + + .. py:attribute:: ENDORSED_UNKNOWN + :value: Ellipsis + + + + .. py:property:: name + :type: str + + The name of the Enum member. + + + .. py:property:: value + :type: int + + The value of the Enum member. + + +.. py:class:: ExecutableForcedLoadSetting(process: str, library: str) + + .. py:method:: enabled() -> bool + + + .. py:method:: forced() -> bool + + + .. py:method:: library() -> str + + + .. py:method:: process() -> str + + + .. py:method:: withEnabled(enabled: bool) -> ExecutableForcedLoadSetting + + + .. py:method:: withForced(forced: bool) -> ExecutableForcedLoadSetting + + +.. py:class:: ExecutableInfo(title: str, binary: Union[str, os.PathLike[str], PyQt6.QtCore.QFileInfo]) + + .. py:method:: arguments() -> Sequence[str] + + + .. py:method:: asCustom() -> ExecutableInfo + + + .. py:method:: binary() -> PyQt6.QtCore.QFileInfo + + + .. py:method:: isCustom() -> bool + + + .. py:method:: isValid() -> bool + + + .. py:method:: steamAppID() -> str + + + .. py:method:: title() -> str + + + .. py:method:: withArgument(argument: str) -> ExecutableInfo + + + .. py:method:: withSteamAppId(app_id: str) -> ExecutableInfo + + + .. py:method:: withWorkingDirectory(directory: Union[str, os.PathLike[str], PyQt6.QtCore.QDir]) -> ExecutableInfo + + + .. py:method:: workingDirectory() -> PyQt6.QtCore.QDir + + +.. py:class:: FileInfo + + Information about a virtualized file + + + .. py:property:: archive + :type: str + + + + .. py:property:: filePath + :type: str + + + + .. py:property:: origins + :type: list[str] + + + +.. py:class:: FileTreeEntry + + Represent an entry in a file tree, either a file or a directory. This class + inherited by IFileTree so that operations on entry are the same for a file or + a directory. + + This class provides convenience methods to query information on the file, like its + name or the its last modification time. It also provides a convenience astree() method + that can be used to retrieve the tree corresponding to its entry in case the entry + represent a directory. + + + .. py:class:: FileTypes(*args, **kwds) + + Bases: :py:obj:`enum.Enum` + + + Enumeration of the different file type or combinations. + + + .. py:method:: __and__(other: FileTreeEntry) -> FileTreeEntry + + + .. py:method:: __eq__(other: object) -> bool + + Return self==value. + + + + .. py:method:: __ge__(other: FileTreeEntry) -> bool + + Return self>=value. + + + + .. py:method:: __gt__(other: FileTreeEntry) -> bool + + Return self>value. + + + + .. py:method:: __int__() -> int + + + .. py:method:: __invert__() -> FileTreeEntry + + + .. py:method:: __le__(other: FileTreeEntry) -> bool + + Return self<=value. + + + + .. py:method:: __lt__(other: FileTreeEntry) -> bool + + Return self bool + + Return self!=value. + + + + .. py:method:: __or__(other: FileTreeEntry) -> FileTreeEntry + + + .. py:method:: __rand__(other: FileTreeEntry) -> FileTreeEntry + + + .. py:method:: __ror__(other: FileTreeEntry) -> FileTreeEntry + + + .. py:method:: __rxor__(other: FileTreeEntry) -> FileTreeEntry + + + .. py:method:: __str__() -> str + + Return str(self). + + + + .. py:method:: __xor__(other: FileTreeEntry) -> FileTreeEntry + + + .. py:attribute:: DIRECTORY + :value: Ellipsis + + + + .. py:attribute:: FILE + :value: Ellipsis + + + + .. py:attribute:: FILE_OR_DIRECTORY + :value: Ellipsis + + + + .. py:property:: name + :type: str + + The name of the Enum member. + + + .. py:property:: value + :type: int + + The value of the Enum member. + + + + .. py:method:: __eq__(other: object) -> bool + + Return self==value. + + + + .. py:method:: detach() -> bool + + Detach this entry from its parent tree. + + :returns: True if the entry was removed correctly, False otherwise. + + + + .. py:method:: fileType() -> FileTreeEntry + + :returns: The filetype of this entry. + + + + .. py:method:: hasSuffix(suffixes: Sequence[str]) -> bool + hasSuffix(suffix: str) -> bool + + Check if this entry has the given suffix. + + :param suffix: Suffix to check. + + :returns: True if this entry is a file and has the given suffix. + + + + .. py:method:: isDir() -> bool + + :returns: True if this entry is a directory, False otherwise. + + + + .. py:method:: isFile() -> bool + + :returns: True if this entry is a file, False otherwise. + + + + .. py:method:: moveTo(tree: IFileTree) -> bool + + Move this entry to the given tree. + + :param tree: The tree to move this entry to. + + :returns: True if the entry was moved correctly, False otherwise. + + + + .. py:method:: name() -> str + + :returns: The name of this entry. + + + + .. py:method:: parent() -> IFileTree | None + + :returns: The parent tree containing this entry, or a `None` if this entry is the root + + or the parent tree is unreachable. + + + + .. py:method:: path(sep: str = '\\') -> str + + Retrieve the path from this entry up to the root of the tree. + + This method propagate up the tree so is not constant complexity as + the full path is never stored. + + :param sep: The type of separator to use to create the path. + + :returns: The path from this entry to the root, including the name of this entry. + + + + .. py:method:: pathFrom(tree: IFileTree, sep: str = '\\') -> str + + Retrieve the path from the given tree to this entry. + + :param tree: The tree to reach, must be a parent of this entry. + :param sep: The type of separator to use to create the path. + + :returns: The path from the given tree to this entry, including the name of this entry, or + + an empty string if the given tree is not a parent of this entry. + + + + .. py:method:: suffix() -> str + + Retrieve the "last" extension of this entry. + + The "last" extension is everything after the last dot in the file name. + + :returns: The last extension of this entry, or an empty string if the file has no extension + + or is directory. + + + + .. py:attribute:: DIRECTORY + :type: FileTreeEntry.FileTypes + :value: Ellipsis + + + + .. py:attribute:: FILE + :type: FileTreeEntry.FileTypes + :value: Ellipsis + + + + .. py:attribute:: FILE_OR_DIRECTORY + :type: FileTreeEntry.FileTypes + :value: Ellipsis + + + +.. py:class:: GameFeature + + Bases: :py:obj:`abc.ABC` + + + Base class for all game features, cannot be inherited, used only for typing + purpose in Python. + + +.. py:class:: GamePlugins + + Bases: :py:obj:`GameFeature` + + + Base class for all game features, cannot be inherited, used only for typing + purpose in Python. + + + .. py:method:: getLoadOrder() -> Sequence[str] + :abstractmethod: + + + + .. py:method:: lightPluginsAreSupported() -> bool + :abstractmethod: + + + :returns: True if light plugins are supported, False otherwise. + + + + .. py:method:: mediumPluginsAreSupported() -> bool + :abstractmethod: + + + :returns: True if medium plugins are supported, False otherwise. + + + + .. py:method:: readPluginLists(plugin_list: IPluginList) -> None + :abstractmethod: + + + + .. py:method:: writePluginLists(plugin_list: IPluginList) -> None + :abstractmethod: + + + +.. py:class:: GuessQuality(*args, **kwds) + + Bases: :py:obj:`enum.Enum` + + + Describes how good the code considers a guess (i.e. for a mod name) this is used to + determine if a name from another source should overwrite or not. + + + .. py:method:: __eq__(other: object) -> bool + + Return self==value. + + + + .. py:method:: __int__() -> int + + + .. py:method:: __ne__(other: object) -> bool + + Return self!=value. + + + + .. py:method:: __str__() -> str + + Return str(self). + + + + .. py:attribute:: FALLBACK + :value: Ellipsis + + + + .. py:attribute:: GOOD + :value: Ellipsis + + + + .. py:attribute:: INVALID + :value: Ellipsis + + + + .. py:attribute:: META + :value: Ellipsis + + + + .. py:attribute:: PRESET + :value: Ellipsis + + + + .. py:attribute:: USER + :value: Ellipsis + + + + .. py:property:: name + :type: str + + The name of the Enum member. + + + .. py:property:: value + :type: int + + The value of the Enum member. + + +.. py:class:: GuessedString + GuessedString(value: str, quality: GuessQuality = GuessQuality.USER) + + Represents a string that may be set from different places. Each time the value is + changed a "quality" is specified to say how probable it is the value is the best choice. + Only the best choice should be used in the end but alternatives can be queried. This + class also allows a filter to be set. If a "guess" doesn't pass the filter, it is ignored. + + + .. py:method:: __str__() -> str + + Return str(self). + + + + .. py:method:: reset() -> GuessedString + reset(value: str, quality: GuessQuality) -> GuessedString + reset(other: GuessedString) -> GuessedString + + Reset this GuessedString object by copying the given one, only + if the given one has better quality. + + :param other: The GuessedString to copy. + + :returns: This GuessedString object. + + + + .. py:method:: setFilter(filter: Callable[[str], Union[str, bool]]) -> None + + Set the filter for this GuessedString. + + The filter is applied on every `update()` and can reject the new value + altogether or modify it (by returning a new value). + + :param filter: The new filter. + + + + .. py:method:: update(value: str) -> GuessedString + update(value: str, quality: GuessQuality) -> GuessedString + + Update this GuessedString by adding a new variants with the given quality. + + If the specified quality is better than the current one, the actual value of + the GuessedString is also updated. + + The GuessedString is only updated if the given value passes the filter. + + :param value: The new variant to add. + :param quality: The quality of the variant. + + :returns: This GuessedString object. + + + + .. py:method:: variants() -> set[str] + + :returns: The list of variants for this GuessedString. + + + +.. py:class:: IDownloadManager + + .. py:method:: downloadPath(id: int) -> str + + Retrieve the (absolute) path of the specified download. + + :param id: ID of the download. + + :returns: The absolute path to the file corresponding to the given download. This file + + may not exist yet if the download is incomplete. + + + + .. py:method:: onDownloadComplete(callback: Callable[[int], None]) -> bool + + Installs a handler to be called when a download completes. + + :param callback: The function to be called when a download complete. The parameter is the download ID. + + :returns: True if the handler was installed properly (there are currently no reasons for this to fail). + + + + .. py:method:: onDownloadFailed(callback: Callable[[int], None]) -> bool + + Installs a handler to be called when a download fails. + + :param callback: The function to be called when a download fails. The parameter is the download ID. + + :returns: True if the handler was installed properly (there are currently no reasons for this to fail). + + + + .. py:method:: onDownloadPaused(callback: Callable[[int], None]) -> bool + + Installs a handler to be called when a download is paused. + + :param callback: The function to be called when a download is paused. The parameter is the download ID. + + :returns: True if the handler was installed properly (there are currently no reasons for this to fail). + + + + .. py:method:: onDownloadRemoved(callback: Callable[[int], None]) -> bool + + Installs a handler to be called when a download is removed. + + :param callback: The function to be called when a download is removed. The parameter is the download ID. + + :returns: True if the handler was installed properly (there are currently no reasons for this to fail). + + + + .. py:method:: startDownloadNexusFile(mod_id: int, file_id: int) -> int + + Download a file from www.nexusmods.com/. is always the game + currently being managed. + + :param mod_id: ID of the mod to download the file from. + :param file_id: ID of the file to download. + + :returns: An ID identifying the download. + + + + .. py:method:: startDownloadURLs(urls: Sequence[str]) -> int + + Download a file by url. + + The list can contain alternative URLs to allow the download manager to switch + in case of download problems + + :param urls: List of urls to download from. + + :returns: An ID identifying the download. + + + +.. py:class:: IFileTree + + Bases: :py:obj:`FileTreeEntry` + + + Interface to classes that provides way to visualize and alter file trees. The tree + may not correspond to an actual file tree on the disk (e.g., inside an archive, + from a QTree Widget, ...). + + Read-only operations on the tree are thread-safe, even when the tree has not been populated + yet. + + In order to prevent wrong usage of the tree, implementing classes may throw + UnsupportedOperationException if an operation is not supported. By default, all operations + are supported, but some may not make sense in many situations. + + The goal of this is not reflect the change made to a IFileTree to the disk, but child + classes may override relevant methods to do so. + + The tree is built upon FileTreeEntry. A given tree holds shared pointers to its entries + while each entry holds a weak pointer to its parent, this means that the descending link + are strong (shared pointers) but the uplink are weak. + + Accessing the parent is always done by locking the weak pointer so that returned pointer + or either null or valid. This structure implies that as long as the initial root lives, + entry should not be destroyed, unless the entry are detached from the root and no shared + pointers are kept. + + However, it is not guarantee that one can go up the tree from a single node entry. If the + root node is destroyed, it will not be possible to go up the tree, even if we still have + a valid shared pointer. + + + .. py:class:: InsertPolicy(*args, **kwds) + + Bases: :py:obj:`enum.Enum` + + + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + + + .. py:method:: __eq__(other: object) -> bool + + Return self==value. + + + + .. py:method:: __int__() -> int + + + .. py:method:: __ne__(other: object) -> bool + + Return self!=value. + + + + .. py:method:: __str__() -> str + + Return str(self). + + + + .. py:attribute:: FAIL_IF_EXISTS + :value: Ellipsis + + + + .. py:attribute:: MERGE + :value: Ellipsis + + + + .. py:attribute:: REPLACE + :value: Ellipsis + + + + .. py:property:: name + :type: str + + The name of the Enum member. + + + .. py:property:: value + :type: int + + The value of the Enum member. + + + + .. py:class:: WalkReturn(*args, **kwds) + + Bases: :py:obj:`enum.Enum` + + + Enumeration that can be returned by the callback for the `walk()` method to stop the + walking operation early. + + + .. py:method:: __eq__(other: object) -> bool + + Return self==value. + + + + .. py:method:: __int__() -> int + + + .. py:method:: __ne__(other: object) -> bool + + Return self!=value. + + + + .. py:method:: __str__() -> str + + Return str(self). + + + + .. py:attribute:: CONTINUE + :value: Ellipsis + + + + .. py:attribute:: SKIP + :value: Ellipsis + + + + .. py:attribute:: STOP + :value: Ellipsis + + + + .. py:property:: name + :type: str + + The name of the Enum member. + + + .. py:property:: value + :type: int + + The value of the Enum member. + + + + .. py:method:: __bool__() -> bool + + :returns: True if this tree is not empty, False otherwise. + + + + .. py:method:: __getitem__(index: int) -> FileTreeEntry + + Retrieve the entry at the given index in this tree. + + :param index: Index of the entry to retrieve, must be less than the size. + + :returns: The entry at the given index. + + :raises IndexError: If the given index is not in range for this tree. + + + + .. py:method:: __iter__() -> Iterator[FileTreeEntry] + + Retrieves an iterator for entries directly under this tree. + + This method does not recurse into subtrees, see `walk()` for this. + + :returns: An iterator object that can be used to iterate over entries in this tree. + + + + .. py:method:: __len__() -> int + + :returns: The number of entries directly under this tree. + + + + .. py:method:: addDirectory(path: str) -> IFileTree + + Create a new directory tree under this tree. + + This method will create missing folders in the given path and will + not fail if the directory already exists but will fail if the given + path contains "." or "..". + This method invalidates iterators to this tree and all the subtrees + present in the given path. + + :param path: Path to the directory to create. + + :returns: An IFileTree corresponding to the created directory. + + :raises RuntimeError: If the directory could not be created. + + + + .. py:method:: addFile(path: str, replace_if_exists: bool = False) -> FileTreeEntry + + Create a new file directly under this tree. + + This method will fail if the file already exists and `replace_if_exists` is `False`. + This method invalidates iterators to this tree and all the subtrees present in the + given path. + + :param path: Path to the file to create. + :param replace_if_exists: If True and an entry already exists at the given location, it will be replaced by + a new entry. This will replace both files and directories. + + :returns: A FileTreeEntry corresponding to the created file. + + :raises RuntimeError: If the file could not be created. + + + + .. py:method:: clear() -> bool + + Delete (detach) all the entries from this tree. + + This method will go through the entries in this tree and stop at the first + entry that cannot be deleted, this means that the tree can be partially cleared. + + :returns: True if all entries have been detached, False otherwise. + + + + .. py:method:: copy(entry: FileTreeEntry, path: str = '', insert_policy: IFileTree = InsertPolicy.FAIL_IF_EXISTS) -> FileTreeEntry + + Move the given entry to the given path under this tree. + + The entry must not be a parent tree of this tree. This method can also be used + to rename entries. + + If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry + at the same location already exists. If the policy is REPLACE, an existing + entry will be replaced. If MERGE, the entry will be merged with the existing + one (if the entry is a file, and a file exists, the file will be replaced). + + This method invalidates iterator to this tree, to the parent tree of the given + entry, and to subtrees of this tree if the insert policy is MERGE. + + :param entry: Entry to copy. + :param path: The path to copy the entry to. If the path ends with / or \, the entry will + be copied in the corresponding directory instead of replacing it. If the + given path is empty (`""`), the entry is copied directly under this tree. + :param insert_policy: Policy to use to resolve conflicts. + + :returns: The new entry (copy of the specified entry). + + :raises RuntimeError: If the entry could not be copied. + + + + .. py:method:: createOrphanTree(name: str = '') -> IFileTree + + Create a new orphan empty tree. + + :param name: Name of the tree. + + :returns: A new tree without any parent. + + + + .. py:method:: exists(path: str, type: FileTreeEntry = FileTreeEntry.FileTypes.FILE_OR_DIRECTORY) -> bool + + Check if the given entry exists. + + :param path: Path to the entry, separated by / or \. + :param type: The type of the entry to check. + + :returns: True if the entry was found, False otherwise. + + + + .. py:method:: find(path: str, type: FileTreeEntry = FileTreeEntry.FileTypes.FILE_OR_DIRECTORY) -> IFileTree | FileTreeEntry | None + + Retrieve the given entry. + + If no entry exists at the given path, or if the entry is not of the right + type, `None` is returned. + + :param path: Path to the entry, separated by / or \. + :param type: The type of the entry to check. + + :returns: The entry at the given location, or `None` if the entry was not found or + + was not of the correct type. + + + + .. py:method:: insert(entry: FileTreeEntry, policy: IFileTree = InsertPolicy.FAIL_IF_EXISTS) -> bool + + Insert the given entry in this tree, removing it from its + previous parent. + + The entry must not be this tree or a parent entry of this tree. + + - If the insert policy if `FAIL_IF_EXISTS`, the call will fail if an entry + with the same name already exists. + - If the policy is `REPLACE`, an existing entry will be replaced by the given entry. + - If the policy is `MERGE`: + + - If there is no entry with the same name, the new entry is inserted. + - If there is an entry with the same name: + + - If both entries are files, the old file is replaced by the given entry. + - If both entries are directories, a merge is performed as if using merge(). + - Otherwise the insertion fails (two entries with different types). + + This method invalidates iterator to this tree, to the parent tree of the given + entry, and to subtrees of this tree if the insert policy is MERGE. + + :param entry: Entry to insert. + :param policy: Policy to use to resolve conflicts. + + :returns: True if the entry was insert, False otherwise. + + + + .. py:method:: merge(other: IFileTree, overwrites: bool = False) -> Union[dict[FileTreeEntry, FileTreeEntry], int] + + Merge the given tree with this tree, i.e., insert all entries + of the given tree into this tree. + + The tree must not be this tree or a parent entry of this tree. Files present in both tree + will be replaced by files in the given tree. After a merge, the source tree will be + empty but still attached to its parent. + + If `overwrites` is `True`, a map from overridden files to new files will be returned. + + Note that the merge process makes no distinction between files and directories + when merging: if a directory is present in this tree and a file from source + is in conflict with it, the tree will be removed and the file inserted; if a file + is in this tree and a directory from source is in conflict with it, the file will + be replaced with the directory. + + This method invalidates iterators to this tree, all the subtrees under this tree + present in the given path, and all the subtrees of the given source. + + :param other: Tree to merge. + :param overwrites: If True, a mapping from overridden files to new files will be returned. + + :returns: If `overwrites` is True, a mapping from overridden files to new files, otherwise + + the number of overwritten entries. + + :raises RuntimeError: If the merge failed. + + + + .. py:method:: move(entry: FileTreeEntry, path: str, policy: IFileTree = InsertPolicy.FAIL_IF_EXISTS) -> bool + + Move the given entry to the given path under this tree. + + The entry must not be a parent tree of this tree. This method can also be used + to rename entries. + + If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry + at the same location already exists. If the policy is REPLACE, an existing + entry will be replaced. If MERGE, the entry will be merged with the existing + one (if the entry is a file, and a file exists, the file will be replaced). + + This method invalidates iterator to this tree, to the parent tree of the given + entry, and to subtrees of this tree if the insert policy is MERGE. + + :param entry: Entry to move. + :param path: The path to move the entry to. If the path ends with / or \, the entry will + be inserted in the corresponding directory instead of replacing it. If the + given path is empty (`""`), this is equivalent to `insert()`. + :param policy: Policy to use to resolve conflicts. + + :returns: True if the entry was moved correctly, False otherwise. + + + + .. py:method:: pathTo(entry: FileTreeEntry, sep: str = '\\') -> str + + Retrieve the path from this tree to the given entry. + + :param entry: The entry to reach, must be in this tree. + :param sep: The type of separator to use to create the path. + + :returns: The path from this tree to the given entry, including the name of the entry, or + + an empty string if the given entry was not found under this tree. + + + + .. py:method:: remove(name: str) -> bool + remove(entry: FileTreeEntry) -> bool + + Delete the given entry. + + :param entry: Entry to delete. The entry must belongs to this tree (and not to a subtree). + + :returns: True if the entry was deleted, False otherwise. + + + + .. py:method:: removeAll(names: Sequence[str]) -> int + + Delete the entries with the given names from the tree. + + This method does not recurse into subtrees, so only entries accessible + directly from this tree will be removed. This method invalidates iterators. + + :param names: Names of the entries to delete. + + :returns: The number of deleted entry. + + + + .. py:method:: removeIf(filter: Callable[[FileTreeEntry], bool]) -> int + + Delete entries matching the given predicate from the tree. + + This method does not recurse into subtrees, so only entries accessible + directly from this tree will be removed. This method invalidates iterators. + + :param filter: Predicate that should return true for entries to delete. + + :returns: The number of deleted entry. + + + + .. py:method:: walk(callback: Callable[[str, FileTreeEntry], IFileTree], sep: str = '\\') -> None + + Walk this tree, calling the given function for each entry in it. + + The given callback will be called with two parameters: the path from this tree to the given entry + (with a trailing separator, not including the entry name), and the actual entry. The method returns + a `WalkReturn` object to indicates what to do. + + :param callback: Method to call for each entry in the tree. + :param sep: Type of separator to use to construct the path. + + + + .. py:attribute:: CONTINUE + :type: IFileTree.WalkReturn + :value: Ellipsis + + + + .. py:attribute:: FAIL_IF_EXISTS + :type: IFileTree.InsertPolicy + :value: Ellipsis + + + + .. py:attribute:: MERGE + :type: IFileTree.InsertPolicy + :value: Ellipsis + + + + .. py:attribute:: REPLACE + :type: IFileTree.InsertPolicy + :value: Ellipsis + + + + .. py:attribute:: SKIP + :type: IFileTree.WalkReturn + :value: Ellipsis + + + + .. py:attribute:: STOP + :type: IFileTree.WalkReturn + :value: Ellipsis + + + +.. py:class:: IGameFeatures + + Interface for the game features, accessible through IOrganizer.gameFeatures(). + + + .. py:method:: gameFeature(feature_type: Type[GameFeatureType]) -> GameFeatureType + + Retrieve the given game feature, if one exists. + + :param feature_type: The class of feature to retrieve. + + :returns: The game feature corresponding to the given type, or `None` if the feature is + + not available. + + + + .. py:method:: registerFeature(games: Sequence[str], feature: GameFeature, priority: int, replace: bool = False) -> bool + registerFeature(game: IPluginGame, feature: GameFeature, priority: int, replace: bool = False) -> bool + registerFeature(feature: GameFeature, priority: int, replace: bool = False) -> bool + + Register game feature for all games. + + This method register a game feature to combine or replace with other features + of the same kind. Some features are merged (e.g., ModDataContent, + ModDataChecker), while other override previous features (e.g., SaveGameInfo). + + For features that can be combined, the priority argument indicates the order of + priority (e.g., the order of the checks for ModDataChecker). For other features, + the feature with the highest priority will be used. The features provided by the + game plugin itself always have lowest priority. + + The feature is associated to the plugin that registers it, if the plugin is + disabled, the feature will not be available. + + This function will return True if the feature was registered, even if the + feature is not used du to its low priority. + + :param feature: Game feature to register. + :param priority: Priority of the game feature. If the plugin registering the feature + is a game plugin, this parameter is ignored. + :param replace: If True, remove features of the same kind registered by the current plugin, + otherwise add the feature alongside existing ones. + + :returns: True if the game feature was properly registered, False otherwise. + + + + .. py:method:: unregisterFeature(feature: GameFeature) -> bool + + Unregister the given game feature. + + This function is safe to use even if the given feature was never registered. + + :param feature: Feature to unregister. + + :returns: True if the feature was successfully unregistered, False otherwise. + + + + .. py:method:: unregisterFeatures(feature_type: Type[GameFeatureType]) -> int + + Unregister all features of the given type registered by the calling plugin. + + This function is safe to use even if the plugin has no feature of the given type + register. + + :param feature_type: The class of feature to unregister. + + :returns: The number of unregistered features. + + + +.. py:class:: IInstallationManager + + .. py:method:: createFile(entry: FileTreeEntry) -> str + + Create a new file on the disk corresponding to the given entry. + + This method can be used by installer that needs to create files that are not in the original + archive. At the end of the installation, if there are entries in the final tree that were used + to create files, the corresponding files will be moved to the mod folder. + + Temporary files corresponding to created files are automatically cleaned up at the end of + the installation. + + :param entry: The entry for which a temporary file should be created. + + :returns: The path to the created file, or an empty string if the file could not be created. + + + + .. py:method:: extractFile(entry: FileTreeEntry, silent: bool = False) -> str + + Extract the specified file from the currently opened archive to a temporary + location. + + This method cannot be used to extract directory. + + The call will fail with an exception if no archive is open (plugins deriving from + IPluginInstallerSimple can rely on that, custom installers should not). The temporary + file is automatically cleaned up after the installation. This call can be very slow + if the archive is large and "solid". + + :param entry: Entry corresponding to the file to extract. + :param silent: If true, the dialog showing extraction progress will not be shown. + + :returns: The absolute path to the temporary file, or an empty string if the file was not extracted. + + + + .. py:method:: extractFiles(entries: list[FileTreeEntry], silent: bool = False) -> Sequence[str] + + Extract the specified files from the currently opened archive to a temporary + location. + + This method cannot be used to extract directories. + + The call will fail with an exception if no archive is open (plugins deriving from + IPluginInstallerSimple can rely on that, custom installers should not). The temporary + files are automatically cleaned up after the installation. This call can be very slow + if the archive is large and "solid". + + :param entries: Entries corresponding to the files to extract. + :param silent: If true, the dialog showing extraction progress will not be shown. + + :returns: A list containing absolute paths to the temporary files. + + + + .. py:method:: getSupportedExtensions() -> Sequence[str] + + :returns: The extensions of archives supported by this installation manager. + + + + .. py:method:: installArchive(mod_name: GuessedString, archive: Union[str, os.PathLike[str], PyQt6.QtCore.QFileInfo], mod_id: int = 0) -> tuple[InstallResult, str, int] + + Install the given archive. + + :param mod_name: Suggested name of the mod. + :param archive: Path to the archive to install. + :param mod_id: ID of the mod, if available. + + :returns: The result of the installation. + + + +.. py:class:: IModInterface + + .. py:method:: absolutePath() -> str + + :returns: Absolute path to the mod to be used in file system operations. + + + + .. py:method:: addCategory(name: str) -> None + + Assign a category to the mod. If the named category does not exist it is created. + + :param name: Name of the new category to assign. + + + + .. py:method:: addNexusCategory(category_id: int) -> None + + Set the category id from a nexus category id. Conversion to MO ID happens internally. + + If a mapping is not possible, the category is set to the default value. + + :param category_id: The Nexus category ID. + + + + .. py:method:: categories() -> Sequence[str] + + :returns: The list of categories this mod belongs to. + + + + .. py:method:: clearPluginSettings(plugin_name: str) -> dict[str, MoVariant] + + Remove all the settings of the specified plugin this mod. + + :param plugin_name: Name of the plugin for which settings should be removed. This should always be `IPlugin.name()` + unless you have a really good reason to access settings of another plugin. + + :returns: The old settings from the given plugin, as returned by `pluginSettings()`. + + + + .. py:method:: color() -> PyQt6.QtGui.QColor + + :returns: The color of the 'Notes' column chosen by the user. + + + + .. py:method:: comments() -> str + + :returns: The comments for this mod, if any. + + + + .. py:method:: converted() -> bool + + Check if the mod was marked as converted by the user. + + When a mod is for a different game, a flag is shown to users to warn them, but + they can mark mods as converted to remove this flag. + + :returns: True if this mod was marked as converted by the user. + + + + .. py:method:: endorsedState() -> EndorsedState + + :returns: The endorsement state of this mod. + + + + .. py:method:: fileTree() -> IFileTree + + Retrieve a file tree corresponding to the underlying disk content of this mod. + + The file tree should not be cached by plugins since it is already and updated when + required. + + :returns: A file tree representing the content of this mod. + + + + .. py:method:: gameName() -> str + + Retrieve the short name of the game associated with this mod. This may differ + from the current game plugin (e.g. you can install a Skyrim LE game in a SSE + installation). + + :returns: The name of the game associated with this mod. + + + + .. py:method:: ignoredVersion() -> VersionInfo + + :returns: The ignored version of this mod (for update), or an invalid version if the user + + did not ignore version for this mod. + + + + .. py:method:: installationFile() -> str + + :returns: The absolute path to the file that was used to install this mod. + + + + .. py:method:: isBackup() -> bool + + :returns: True if this mod represents a backup. + + + + .. py:method:: isForeign() -> bool + + :returns: True if this mod represents a foreign mod, not managed by MO2. + + + + .. py:method:: isOverwrite() -> bool + + :returns: True if this mod represents the overwrite mod. + + + + .. py:method:: isSeparator() -> bool + + :returns: True if this mod represents a separator. + + + + .. py:method:: name() -> str + + :returns: The name of this mod. + + + + .. py:method:: newestVersion() -> VersionInfo + + :returns: The newest version of this mod (as known by MO2). If this matches version(), + + then the mod is up-to-date. + + + + .. py:method:: nexusId() -> int + + :returns: The Nexus ID of this mod. + + + + .. py:method:: notes() -> str + + :returns: The notes for this mod, if any. + + + + .. py:method:: pluginSetting(plugin_name: str, key: str, default: MoVariant = None) -> MoVariant + + Retrieve the specified setting in this mod for a plugin. + + :param plugin_name: Name of the plugin for which to retrieve a setting. This should always be `IPlugin.name()` + unless you have a really good reason to access settings of another plugin. + :param key: Identifier of the setting. + :param default: The default value to return if the setting does not exist. + + :returns: The setting, if found, or the default value. + + + + .. py:method:: pluginSettings(plugin_name: str) -> dict[str, MoVariant] + + Retrieve the settings in this mod for a plugin. + + :param plugin_name: Name of the plugin for which to retrieve settings. This should always be `IPlugin.name()` + unless you have a really good reason to access settings of another plugin. + + :returns: A map from setting key to value. The map is empty if there are not settings for this mod. + + + + .. py:method:: primaryCategory() -> int + + :returns: The ID of the primary category of this mod. + + + + .. py:method:: removeCategory(name: str) -> bool + + Unassign a category from this mod. + + :param name: Name of the category to remove. + + :returns: True if the category was removed, False otherwise (e.g. if no such category + + was assigned). + + + + .. py:method:: repository() -> str + + :returns: The name of the repository from which this mod was installed. + + + + .. py:method:: setGameName(name: str) -> None + + Set the source game of this mod. + + :param name: The new source game short name of this mod. + + + + .. py:method:: setIsEndorsed(endorsed: bool) -> None + + Set endorsement state of the mod. + + :param endorsed: New endorsement state of this mod. + + + + .. py:method:: setNewestVersion(version: VersionInfo) -> None + + Set the latest known version of this mod. + + :param version: The latest known version of this mod. + + + + .. py:method:: setNexusID(nexus_id: int) -> None + + Set the Nexus ID of this mod. + + :param nexus_id: Thew new Nexus ID of this mod. + + + + .. py:method:: setPluginSetting(plugin_name: str, key: str, value: MoVariant) -> bool + + Set the specified setting in this mod for a plugin. + + :param plugin_name: Name of the plugin for which to retrieve a setting. This should always be `IPlugin.name()` + unless you have a really good reason to access settings of another plugin. + :param key: Identifier of the setting. + :param value: New value for the setting to set. + + :returns: True if the setting was set correctly, False otherwise. + + + + .. py:method:: setUrl(url: str) -> None + + Set the URL of this mod. + + :param url: The URL of this mod. + + + + .. py:method:: setVersion(version: VersionInfo) -> None + + Set the version of this mod. + + :param version: The new version of this mod. + + + + .. py:method:: trackedState() -> TrackedState + + :returns: The tracked state of this mod. + + + + .. py:method:: url() -> str + + :returns: The URL of this mod, or an empty QString() if no URL is associated + + with this mod. + + + + .. py:method:: validated() -> bool + + Check if the mod was marked as validated by the user. + + MO2 uses ModDataChecker to check the content of mods, but sometimes these fail, in + which case mods are incorrectly marked as 'not containing valid games data'. Users can + choose to mark these mods as valid to hide the warning / flag. + + :returns: True if th is mod was marked as containing valid game data. + + + + .. py:method:: version() -> VersionInfo + + :returns: The current version of this mod. + + + +.. py:class:: IModList + + Interface to the mod-list. + + All api functions in this interface work need the internal name of a mod to find a + mod. For regular mods (mods the user installed) the display name (as shown to the user) + and internal name are identical. For other mods (non-MO mods) there is currently no way + to translate from display name to internal name because the display name might not me un-ambiguous. + + + .. py:method:: allMods() -> Sequence[str] + + :returns: A list containing the internal names of all installed mods. + + + + .. py:method:: allModsByProfilePriority(profile: IProfile | None = None) -> Sequence[str] + + :returns: The list of mod (names), sorted according to the current profile priorities. + + + + .. py:method:: displayName(name: str) -> str + + Retrieve the display name of a mod from its internal name. + + If you received an internal name from the API (e.g. `IPluginList.origin`) then you should use + that name to identify the mod in all other api calls but use this function to retrieve the name + to show to the user. + + :param name: Internal name of the mod. + + :returns: The display name of the given mod. + + + + .. py:method:: getMod(name: str) -> IModInterface + + Retrieve an interface to a mod using its name. + + :param name: Name of the mod to retrieve. + + :returns: An interface to the given mod, or `None` if there is no mod with this name. + + + + .. py:method:: onModInstalled(callback: Callable[[IModInterface], None]) -> bool + + Install a new handler to be called when a new mod is installed. + + :param callback: The function to call when a mod is installed. The parameter of the function is the name of the + newly installed mod. + + :returns: True if the handler was installed properly (there are currently no reasons for this to fail). + + + + .. py:method:: onModMoved(callback: Callable[[str, int, int], None]) -> bool + + Install a handler to be called when a mod is moved. + + :param callback: The function to call when a mod is moved. The first argument is the internal name of the + mod, the second argument the old priority and the third argument the new priority. + + :returns: True if the handler was installed properly (there are currently no reasons for this to fail). + + + + .. py:method:: onModRemoved(callback: Callable[[str], None]) -> bool + + Install a new handler to be called when a mod is removed. + + :param callback: The function to call when a mod is removed. The parameter of the function is the name of the + removed mod. + + :returns: True if the handler was installed properly (there are currently no reasons for this to fail). + + + + .. py:method:: onModStateChanged(callback: Callable[[dict[str, ModState]], None]) -> bool + + Install a handler to be called when mod states change (enabled/disabled, endorsed, ...). + + :param callback: The function to call when the states of mod change. The argument is a map containing the + mods whose states have changed. Keys are internal mod names and values are mod states. + + :returns: True if the handler was installed properly (there are currently no reasons for this to fail). + + + + .. py:method:: priority(name: str) -> int + + Retrieve the priority of a mod. + + :param name: Internal name of the mod. + + :returns: The priority of the given mod. + + + + .. py:method:: removeMod(mod: IModInterface) -> bool + + Remove a mod (from disc and from the UI). + + :param mod: The mod to remove. + + :returns: True if the mod was removed, False otherwise. + + + + .. py:method:: renameMod(mod: IModInterface, name: str) -> IModInterface + + Rename the given mod. + + This method usually invalidates the given mod so you should use the returned value + after calling it instead of the passed value. + + :param mod: The mod to rename. + :param name: The new name of the mod. + + :returns: A valid reference to the given mod after renaming it. + + + + .. py:method:: setActive(names: Sequence[str], active: bool) -> int + setActive(name: str, active: bool) -> bool + + Enable or disable a mod. + + Calling this will cause MO to re-evaluate its virtual file system so this is + a fairly expensive call. + + :param name: Internal name of the mod to enable or disable. + :param active: True to enable the mod, False to disable it. + + :returns: True on success, False otherwise. + + + + .. py:method:: setPriority(name: str, priority: int) -> bool + + Change the priority of a mod. + + `priority` is the new priority after the move. Keep in mind that the mod disappears from its + old location and all mods with higher priority than the moved mod decrease in priority by one. + + :param name: Internal name of the mod. + :param priority: The new priority of the mod. + + :returns: True if the priority was changed, False otherwise (if the name or priority were invalid). + + + + .. py:method:: state(name: str) -> ModState + + Retrieve the state of a mod. + + :param name: Internal name of the mod. + + :returns: The state of the given mod. + + + +.. py:class:: IModRepositoryBridge + + Bases: :py:obj:`PyQt6.QtCore.QObject` + + + .. py:method:: __getattr__(arg0: str) -> object + + + .. py:method:: _object() -> PyQt6.QtCore.QObject + + :returns: The underlying `QObject` for the bridge. + + + + .. py:method:: requestDescription(game_name: str, mod_id: int, user_data: MoVariant) -> None + + Request description of a mod. + + :param game_name: Name of the game containing the mod. + :param mod_id: Nexus ID of the mod. + :param user_data: User data to be returned with the result. + + + + .. py:method:: requestDownloadURL(game_name: str, mod_id: int, file_id: int, user_data: MoVariant) -> None + + Request download URL for mod file.0 + + :param game_name: Name of the game containing the mod. + :param mod_id: Nexus ID of the mod. + :param file_id: ID of the file for which a URL should be returned. + :param user_data: User data to be returned with the result. + + + + .. py:method:: requestFileInfo(game_name: str, mod_id: int, file_id: int, user_data: MoVariant) -> None + + :param game_name: Name of the game containing the mod. + :param mod_id: Nexus ID of the mod. + :param file_id: ID of the file for which information is requested. + :param user_data: User data to be returned with the result. + + + + .. py:method:: requestFiles(game_name: str, mod_id: int, user_data: MoVariant) -> None + + Request the list of files belonging to a mod. + + :param game_name: Name of the game containing the mod. + :param mod_id: Nexus ID of the mod. + :param user_data: User data to be returned with the result. + + + + .. py:method:: requestToggleEndorsement(game_name: str, mod_id: int, mod_version: str, endorse: bool, user_data: MoVariant) -> None + + :param game_name: Name of the game containing the mod. + :param mod_id: Nexus ID of the mod. + :param mod_version: Version of the mod. + :param endorse: + :param user_data: User data to be returned with the result. + + + + .. py:attribute:: descriptionAvailable + :type: PyQt6.QtCore.pyqtSignal + :value: Ellipsis + + + + .. py:attribute:: downloadURLsAvailable + :type: PyQt6.QtCore.pyqtSignal + :value: Ellipsis + + + + .. py:attribute:: endorsementToggled + :type: PyQt6.QtCore.pyqtSignal + :value: Ellipsis + + + + .. py:attribute:: endorsementsAvailable + :type: PyQt6.QtCore.pyqtSignal + :value: Ellipsis + + + + .. py:attribute:: fileInfoAvailable + :type: PyQt6.QtCore.pyqtSignal + :value: Ellipsis + + + + .. py:attribute:: filesAvailable + :type: PyQt6.QtCore.pyqtSignal + :value: Ellipsis + + + + .. py:attribute:: requestFailed + :type: PyQt6.QtCore.pyqtSignal + :value: Ellipsis + + + + .. py:attribute:: trackedModsAvailable + :type: PyQt6.QtCore.pyqtSignal + :value: Ellipsis + + + + .. py:attribute:: trackingToggled + :type: PyQt6.QtCore.pyqtSignal + :value: Ellipsis + + + +.. py:class:: IOrganizer + + Interface to class that provides information about the running session + of Mod Organizer to be used by plugins. + + + .. py:method:: appVersion() -> VersionInfo + + :returns: The running version of Mod Organizer. + + + + .. py:method:: basePath() -> str + + :returns: The absolute path to the base directory of Mod Organizer. + + + + .. py:method:: createMod(name: GuessedString) -> IModInterface + + Create a new mod with the specified name. + + If a mod with the same name already exists, the user will be queried. If the user chooses + to merge or replace, the call will succeed, otherwise the call will fail. + + :param name: Name of the mod to create. + + :returns: An interface to the newly created mod that can be used to modify it, or `None` if the mod + + could not be created. + + + + .. py:method:: createNexusBridge() -> IModRepositoryBridge + + Create a new Nexus interface. + + :returns: The newly created Nexus interface. + + + + .. py:method:: downloadManager() -> IDownloadManager + + :returns: The interface to the download manager. + + + + .. py:method:: downloadsPath() -> str + + :returns: The absolute path to the download directory. + + + + .. py:method:: findFileInfos(path: Union[str, os.PathLike[str], PyQt6.QtCore.QDir], filter: Callable[[FileInfo], bool]) -> Sequence[FileInfo] + + Find files in the virtual directory matching the specified filter. + + :param path: The path to search in (relative to the 'data' folder). + :param filter: The function to use to filter files. Should return True for the files to keep. + + :returns: The list of `QFileInfo` corresponding to the matching files. + + + + .. py:method:: findFiles(path: Union[str, os.PathLike[str], PyQt6.QtCore.QDir], filter: Callable[[str], bool]) -> Sequence[str] + findFiles(path: Union[str, os.PathLike[str], PyQt6.QtCore.QDir], patterns: Sequence[str]) -> Sequence[str] + findFiles(path: Union[str, os.PathLike[str], PyQt6.QtCore.QDir], pattern: str) -> Sequence[str] + + Find files in the given folder that matches the given glob pattern. + + :param path: The path to search in (relative to the 'data' folder). + :param pattern: The glob pattern to use to filter files. + + :returns: The list of matching files. + + + + .. py:method:: gameFeatures() -> IGameFeatures + + :returns: The interface to the game features. + + + + .. py:method:: getFileOrigins(filename: str) -> Sequence[str] + + Retrieve the file origins for the specified file. + + The origins are listed with their internal name. The internal name of a mod can differ + from the display name for disambiguation. + + :param filename: Path to the file to retrieve origins for (relative to the 'data' folder). + + :returns: The list of origins that contain the specified file, sorted by their priority. + + + + .. py:method:: getGame(name: str) -> IPluginGame + + Retrieve the game plugin matching the given name. + + :param name: Name of the game (short name). + + :returns: The plugin for the given game, or `None` if none was found. + + + + .. py:method:: getPluginDataPath() -> str + :staticmethod: + + + :returns: The directory for plugin data, typically plugins/data. + + + + .. py:method:: installMod(filename: Union[str, os.PathLike[str], PyQt6.QtCore.QFileInfo], name_suggestion: str = '') -> IModInterface + + Install a mod archive at the specified location. + + :param filename: Absolute filepath to the archive to install. + :param name_suggestion: Suggested name for this mod. This can still be changed by the user. + + :returns: An interface to the new installed mod, or `None` if no installation took place (canceled or failure). + + + + .. py:method:: isPluginEnabled(plugin: IPlugin) -> bool + isPluginEnabled(plugin: str) -> bool + + Check if a plugin is enabled. + + :param plugin: The name of the plugin to check. + + :returns: True if the plugin is enabled, False otherwise. + + + + .. py:method:: listDirectories(directory: str) -> Sequence[str] + + Retrieve the list of (virtual) subdirectories in the given path. + + :param directory: Path to the directory to list (relative to the 'data' folder). + + :returns: The list of directories in the given directory. + + + + .. py:method:: managedGame() -> IPluginGame + + :returns: The plugin corresponding to the current game. + + + + .. py:method:: modDataChanged(mod: IModInterface) -> None + + Notify the organizer that the given mod has changed. + + :param mod: The mod that has changed. + + + + .. py:method:: modList() -> IModList + + :returns: The interface to the mod list. + + + + .. py:method:: modsPath() -> str + + :returns: The (absolute) path to the mods directory. + + + + .. py:method:: onAboutToRun(callback: Callable[[str, PyQt6.QtCore.QDir, str], bool]) -> bool + onAboutToRun(callback: Callable[[str], bool]) -> bool + + Install a new handler to be called when an application is about to run. + + Multiple handlers can be installed. If any of the handler returns `False`, the + application will not run. + + :param callback: The function to call when an application is about to run. The parameter + is the absolute path to the application to run. The function can return False + to prevent the application from running. + + :returns: True if the handler was installed properly (there are currently no reasons for + + this to fail). + + + + .. py:method:: onFinishedRun(callback: Callable[[str, int], None]) -> bool + + Install a new handler to be called when an application has finished running. + + :param callback: The function to call when an application has finished running. The first parameter is the absolute + path to the application, and the second parameter is the exit code of the application. + + :returns: True if the handler was installed properly (there are currently no reasons for + + this to fail). + + + + .. py:method:: onNextRefresh(callback: Callable[[], None], immediate_if_possible: bool = True) -> bool + + Install a new handler to be called on the next refresh or immediately. + + :param callback: Function to call on the next refresh (or immediately). + :param immediate_if_possible: If True, immediately run the callback if no refresh is currently running. + + :returns: True if the handler was installed properly (there are currently no reasons for + + this to fail). + + + + .. py:method:: onPluginDisabled(callback: Callable[[IPlugin], None]) -> None + onPluginDisabled(name: str, callback: Callable[[], None]) -> None + + Install a new handler to be called when the given plugin is disabled. + + :param name: Name of the plugin to watch. + :param callback: The function to call when the plugin is disabled. + + + + .. py:method:: onPluginEnabled(callback: Callable[[IPlugin], None]) -> None + onPluginEnabled(name: str, callback: Callable[[], None]) -> None + + Install a new handler to be called when the given plugin is enabled. + + :param name: Name of the plugin to watch. + :param callback: The function to call when the plugin is enabled. + + + + .. py:method:: onPluginSettingChanged(callback: Callable[[str, str, MoVariant, MoVariant], None]) -> bool + + Install a new handler to be called when a plugin setting is changed. + + :param callback: The function to call when a plugin setting is changed. The parameters are: The name of the plugin, the + name of the setting, the old value (or `None` if the setting did not exist before) and the new value + of the setting (or `None` if the setting has been removed). + + :returns: True if the handler was installed properly (there are currently no reasons for this to fail). + + + + .. py:method:: onProfileChanged(callback: Callable[[IProfile, IProfile], None]) -> bool + + Install a new handler to be called when the current profile is changed. + + The function is called when the profile is changed but some operations related to + the profile might not be finished when this is called (e.g., the virtual file system + might not be up-to-date). + + :param callback: The function to call when the current profile is changed. The first parameter is the old profile (can + be `None`, e.g. at startup), and the second parameter is the new profile (cannot be `None`). + + :returns: True if the handler was installed properly (there are currently no reasons for this to fail). + + + + .. py:method:: onProfileCreated(callback: Callable[[IProfile], None]) -> bool + + Install a new handler to be called when a new profile is created. + + :param callback: The function to call when a new profile is created. The parameter is the new profile (can be + a temporary object and should not be stored). + + :returns: True if the handler was installed properly (there are currently no reasons for this to fail). + + + + .. py:method:: onProfileRemoved(callback: Callable[[str], None]) -> bool + + Install a new handler to be called when a profile is remove. + + The callbacks are called after the profile has been removed so the profile is not accessible + anymore. + + :param callback: The function to call when a profile is remove. The parameter is the name of the profile that was + removed. + + :returns: True if the handler was installed properly (there are currently no reasons for this to fail). + + + + .. py:method:: onProfileRenamed(callback: Callable[[IProfile, str, str], None]) -> bool + + Install a new handler to be called when a profile is renamed. + + :param callback: The function to call when a profile is renamed. The first parameter is the profile being renamed, + the second parameter the previous name and the third parameter the new name. + + :returns: True if the handler was installed properly (there are currently no reasons for this to fail). + + + + .. py:method:: onUserInterfaceInitialized(callback: Callable[[PyQt6.QtWidgets.QMainWindow], None]) -> bool + + Install a new handler to be called when the UI has been fully initialized. + + :param callback: The function to call when the user-interface has been fully initialized. The parameter is the main + window of the application (`QMainWindow`). + + :returns: True if the handler was installed properly (there are currently no reasons for this to fail). + + + + .. py:method:: overwritePath() -> str + + :returns: The (absolute) path to the overwrite directory. + + + + .. py:method:: persistent(plugin_name: str, key: str, default: MoVariant = None) -> MoVariant + + Retrieve the specified persistent value for a plugin. + + A persistent is an arbitrary value that the plugin can set and retrieve that is persistently stored + by the main application. There is no UI for the user to change this value but they can directly access + the storage + + :param plugin_name: Name of the plugin for which to retrieve the value. This should always be `IPlugin.name()` unless you have a + really good reason to access data of another mod AND if you can verify that plugin is actually installed. + :param key: Identifier of the setting. + :param default: Default value to return if the key is not set (yet). + + :returns: The value corresponding to the given persistent setting, or `def` is the key is not found. + + + + .. py:method:: pluginDataPath() -> str + + Retrieve the path to a directory where plugin data should be stored. + + For python plugins, it is recommended to use a dedicated folder (per plugin) if you need to + store data (resources, or multiple python files). + + :returns: Path to a directory where plugin data should be stored. + + + + .. py:method:: pluginList() -> IPluginList + + :returns: The plugin list interface. + + + + .. py:method:: pluginSetting(plugin_name: str, key: str) -> MoVariant + + Retrieve settings of plugins. + + :param plugin_name: Name of the plugin to retrieve the setting for. + :param key: Name of the setting to retrieve the value for. + + :returns: The value of the setting. + + + + .. py:method:: profile() -> IProfile + + :returns: The interface to the current profile. + + + + .. py:method:: profileName() -> str + + :returns: The name of the current profile, or an empty string if no profile has been loaded (yet). + + + + .. py:method:: profilePath() -> str + + :returns: The absolute path to the active profile or an empty string if no profile has been loaded (yet). + + + + .. py:method:: refresh(save_changes: bool = True) -> None + + Refresh the internal mods file structure from disk. This includes the mod list, the plugin + list, data tab and other smaller things like problems button (same as pressing F5). + + The main part of the refresh of the mods file structure, mod list and plugin list is done + asynchronously, so you should not expect them to be up-to-date when this function returns. + + :param save_changes: If True, the relevant profile information is saved first (enabled mods and order of mods). + + + + .. py:method:: resolvePath(filename: Union[str, os.PathLike[str], PyQt6.QtCore.QFileInfo]) -> str + + Resolves a path relative to the virtual data directory to its absolute real path. + + :param filename: Path to resolve. + + :returns: The absolute real path, or an empty string if the path was not found. + + + + .. py:method:: setPersistent(plugin_name: str, key: str, value: MoVariant, sync: bool = True) -> None + + Set the specified persistent value for a plugin. + + This does not update the in-memory value for this setting, see `setPluginSetting()` for this. + + :param plugin_name: Name of the plugin for which to change a value. This should always be `IPlugin.name()` unless you have a + really good reason to access data of another mod AND if you can verify that plugin is actually installed. + :param key: Identifier of the setting. + :param value: New value for the setting. + :param sync: If True, the storage is immediately written to disc. This costs performance but is safer against data loss. + + + + .. py:method:: setPluginSetting(plugin_name: str, key: str, value: MoVariant) -> None + + Set the specified setting for a plugin. + + This automatically notify handlers register with `onPluginSettingChanged`, so you do not have to do it yourself. + + :param plugin_name: Name of the plugin for which to change a value. This should always be `IPlugin.name()` unless you have a + really good reason to access data of another mod AND if you can verify that plugin is actually installed. + :param key: Identifier of the setting. + :param value: New value for the setting. + + + + .. py:method:: startApplication(executable: Union[str, os.PathLike[str], PyQt6.QtCore.QFileInfo], args: Sequence[str] = [], cwd: Union[str, os.PathLike[str], PyQt6.QtCore.QDir] = '', profile: str = '', forcedCustomOverwrite: str = '', ignoreCustomOverwrite: bool = False) -> int + + Starts an application with virtual filesystem active. + + :param executable: Name or path of the executable. If this is only a filename, it will only work if it has been configured + in MO as an executable. If it is a relative path it is expected to be relative to the game directory. + :param args: Arguments to pass to the executable. If the list is empty, and `executable` refers to a configured executable, + the configured arguments are used. + :param cwd: The working directory for the executable. If this is empty, the path to the executable is used unless `executable` + referred to a configured MO executable, in which case the configured cwd is used. + :param profile: Profile to use. If this is empty (the default) the current profile is used. + :param forcedCustomOverwrite: The mod to set as the custom overwrite, regardless of what the profile has configured. + :param ignoreCustomOverwrite: Set to true to ignore the profile's configured custom overwrite. + + :returns: The handle to the started application, or 0 if the application failed to start. + + + + .. py:method:: virtualFileTree() -> IFileTree + + Retrieve a IFileTree object representing the virtual file tree. + + :returns: An IFileTree representing the virtual file tree. + + + + .. py:method:: waitForApplication(handle: int, refresh: bool = True) -> tuple[bool, int] + + Wait for the application corresponding to the given handle to finish. + + This will always show the lock overlay, regardless of whether the + user has disabled locking in the setting, so use this with care. + Note that the lock overlay will always allow the user to unlock, in + which case this will return False. + + :param handle: Handle of the application to wait for (as returned by `startApplication()`). + :param refresh: Whether ModOrganizer should refresh after the process completed or not. + + :returns: A tuple `(result, exitcode)`, where `result` is a boolean indicating if the application + + completed successfully, and `exitcode` is the exit code of the application. + + + +.. py:class:: IPlugin + + Bases: :py:obj:`abc.ABC` + + + Base class for all plugins. + + + .. py:method:: author() -> str + :abstractmethod: + + + :returns: The name of the plugin author. + + + + .. py:method:: description() -> str + :abstractmethod: + + + :returns: The description for this plugin. + + + + .. py:method:: enabledByDefault() -> bool + + Check whether this plugin should be enabled by default. + + :returns: True if this plugin should be enabled by default, False otherwise. + + + + .. py:method:: init(organizer: IOrganizer) -> bool + :abstractmethod: + + + Initialize this plugin. + + Note that this function may never be called if no `IOrganizer` is available + at that time, such as when creating the first instance in MO. + + Plugins will probably want to store the organizer pointer. It is guaranteed + to be valid as long as the plugin is loaded. + + These functions may be called before `init()`: + + - `name()` + - see `IPluginGame` for more. + + :param organizer: The main organizer interface. + + :returns: True if the plugin was initialized correctly, False otherwise. + + + + .. py:method:: localizedName() -> str + + Retrieve the localized name of the plugin. + + Unlike `name()`, this method can (and should!) return a localized name for the plugin. + This method returns name() by default. + + :returns: The localized name of the plugin. + + + + .. py:method:: master() -> str + + Retrieve the master plugin of this plugin. + + It is often easier to implement a functionality as multiple plugins in MO2, but ship the + plugins together, e.g. as a Python module or using `createFunctions()`. In this case, having + a master plugin (one of the plugin, or a separate one) tells MO2 that these plugins are + linked and should also be displayed together in the UI. If MO2 ever implements automatic + updates for plugins, the `master()` plugin will also be used for this purpose. + + :returns: The master plugin of this plugin, or a null pointer if this plugin does not have a master. + + + + .. py:method:: name() -> str + :abstractmethod: + + + Retrieve the name of the plugin. + + The name of the plugin is used for internal storage purpose so it should not change, + and it should be static. In particular, you should not use a localized string (`tr()`) + for the plugin name. + + In the future, we will provide a way to localized plugin names using a distinct method, + such as `localizedName()`. + + :returns: The name of the plugin. + + + + .. py:method:: requirements() -> list[IPluginRequirement] + + Retrieve the requirements for this plugin. + + This method is called right after `init()` and the ownership the requirements is + + :returns: The list of requirements for this plugin. + + + + .. py:method:: settings() -> Sequence[PluginSetting] + :abstractmethod: + + + :returns: A list of settings for this plugin. + + + + .. py:method:: version() -> VersionInfo + :abstractmethod: + + + :returns: The version of this plugin. + + + +.. py:class:: IPluginDiagnose + + Bases: :py:obj:`IPlugin` + + + Plugins that create problem reports to be displayed in the UI. + + This can be used to report problems related to the same plugin (which implements further + interfaces) or as a stand-alone diagnosis tool. + + + .. py:method:: _invalidate() -> None + + Invalidate the problems corresponding to this plugin. + + + + .. py:method:: activeProblems() -> list[int] + :abstractmethod: + + + Retrieve the list of active problems found by this plugin. + + This method returns a list of problem IDs, that are then used when calling other methods + such as `shortDescription()` or `hasGuidedFix()`. + + :returns: The list of active problems for this plugin. + + + + .. py:method:: fullDescription(key: int) -> str + :abstractmethod: + + + Retrieve the full description of the problem corresponding to the given key. + + :param key: ID of the problem. + + :returns: The full description of the problem. + + :raises IndexError: If the key is not valid. + + + + .. py:method:: hasGuidedFix(key: int) -> bool + :abstractmethod: + + + Check if the problem corresponding to the given key has a guided fix. + + :param key: ID of the problem. + + :returns: True if there is a guided fix for the problem, False otherwise. + + :raises IndexError: If the key is not valid. + + + + .. py:method:: shortDescription(key: int) -> str + :abstractmethod: + + + Retrieve the short description of the problem corresponding to the given key. + + :param key: ID of the problem. + + :returns: The short description of the problem. + + :raises IndexError: If the key is not valid. + + + + .. py:method:: startGuidedFix(key: int) -> None + :abstractmethod: + + + Starts a guided fix for the problem corresponding to the given key. + + This method should throw `ValueError` if there is no guided fix for the corresponding + problem. + + :param key: ID of the problem. + + :raises IndexError: If the key is not valid. + :raises ValueError: If there is no guided fix for this problem. + + + +.. py:class:: IPluginFileMapper + + Bases: :py:obj:`IPlugin` + + + Plugins that adds virtual file links. + + + .. py:method:: mappings() -> list[Mapping] + :abstractmethod: + + + :returns: Mapping for the virtual file system (VFS). + + + +.. py:class:: IPluginGame + + Bases: :py:obj:`IPlugin` + + + Base classes for game plugins. + + Each game requires a specific game plugin. These plugins were initially designed for + Bethesda games, so a lot of methods and attributes are irrelevant for other games. If + you wish to write a plugin for a much simpler game, please consider the `basic_games` + plugin: https://github.com/ModOrganizer2/modorganizer-basic_games + + + .. py:method:: CCPlugins() -> Sequence[str] + + :returns: The current list of active Creation Club plugins. + + + + .. py:method:: DLCPlugins() -> Sequence[str] + + :returns: The list of esp/esm files that are part of known DLCs. + + + + .. py:method:: binaryName() -> str + :abstractmethod: + + + :returns: The name of the default executable to run (relative to the game folder). + + + + .. py:method:: dataDirectory() -> PyQt6.QtCore.QDir + :abstractmethod: + + + :returns: The path to the directory containing data (absolute path). + + + + .. py:method:: detectGame() -> None + :abstractmethod: + + + Detect the game. + + This method is the first called for game plugins (before `init()`). The following + methods should work properly after the call to `detectGame()` (and before `init()`): + + - gameName() + - isInstalled() + - gameIcon() + - gameDirectory() + - dataDirectory() + - gameVariants() + - looksValid() + + See `IPlugin.init()` for more. + + + + .. py:method:: displayGameName() -> str + + :returns: The name of the game to user for display, default to gameName(). + + + + .. py:method:: documentsDirectory() -> PyQt6.QtCore.QDir + :abstractmethod: + + + :returns: The directory of the documents folder where configuration files and such for this game reside. + + + + .. py:method:: enabledPlugins() -> Sequence[str] + + :returns: A list of plugins enabled by the game but not in a strict load order. + + + + .. py:method:: executableForcedLoads() -> Sequence[ExecutableForcedLoadSetting] + :abstractmethod: + + + :returns: A list of automatically discovered libraries that can be force loaded with executables. + + + + .. py:method:: executables() -> Sequence[ExecutableInfo] + + :returns: A list of automatically discovered executables of the game itself and tools surrounding it. + + + + .. py:method:: gameDirectory() -> PyQt6.QtCore.QDir + :abstractmethod: + + + :returns: The directory containing the game installation. + + + + .. py:method:: gameIcon() -> PyQt6.QtGui.QIcon + :abstractmethod: + + + :returns: The icon representing the game. + + + + .. py:method:: gameName() -> str + :abstractmethod: + + + :returns: The name of the game (for internal usage). + + + + .. py:method:: gameNexusName() -> str + + :returns: The name of the game identifier for Nexus. + + + + .. py:method:: gameShortName() -> str + :abstractmethod: + + + :returns: The short name of the game. + + + + .. py:method:: gameVariants() -> Sequence[str] + + Retrieve the list of variants for this game. + + If there are multiple variants of a game (and the variants make a difference to the + plugin), like a regular one and a GOTY-edition, the plugin can return a list of them + and the user gets to chose which one he owns. + + :returns: The list of variants of the game. + + + + .. py:method:: gameVersion() -> str + :abstractmethod: + + + :returns: The version of the game. + + + + .. py:method:: getLauncherName() -> str + :abstractmethod: + + + :returns: The name of the launcher executable to run (relative to the game folder), or an + + empty string if there is no launcher. + + + + .. py:method:: getSupportURL() -> str + :abstractmethod: + + + :returns: An URL for the support page of this game. + + + + .. py:method:: iniFiles() -> Sequence[str] + + :returns: The list of INI files this game uses. The first file in the list should be the + + 'main' INI file. + + + + .. py:method:: initializeProfile(directory: PyQt6.QtCore.QDir, settings: ProfileSetting) -> None + :abstractmethod: + + + Initialize a profile for this game. + + The MO app does not yet support virtualizing only specific aspects but plugins should be written + with this future functionality in mind. + + This function will be used to initially create a profile, potentially to repair it or upgrade/downgrade + it so the implementations have to gracefully handle the case that the directory already contains files. + + :param directory: The directory where the profile is to be initialized. + :param settings: The parameters for how the profile should be initialized. + + + + .. py:method:: isInstalled() -> bool + :abstractmethod: + + + :returns: True if this game has been discovered as installed, False otherwise. + + + + .. py:method:: listSaves(folder: PyQt6.QtCore.QDir) -> list[ISaveGame] + :abstractmethod: + + + List saves in the given directory. + + :param folder: The folder to list saves from. + + :returns: The list of game saves in the given folder. + + + + .. py:method:: loadOrderMechanism() -> LoadOrderMechanism + + :returns: The load order mechanism used by this game. + + + + .. py:method:: looksValid(directory: PyQt6.QtCore.QDir) -> bool + :abstractmethod: + + + Check if the given directory looks like a valid game installation. + + :param directory: Directory to check. + + :returns: True if the directory looks like a valid installation of this game, False otherwise. + + + + .. py:method:: lootGameName() -> str + + :returns: The game name to use when calling LOOT from MO2, default to gameShortName(). + + + + .. py:method:: nexusGameID() -> int + :abstractmethod: + + + Retrieve the Nexus game ID for this game. + + Example: For Skyrim, the Nexus game ID is 110. + + :returns: The Nexus game ID for this game. + + + + .. py:method:: nexusModOrganizerID() -> int + + Retrieve the Nexus mod ID of Mod Organizer for this game. + + Example: For Skyrim SE, the mod ID of MO2 is 6194. You can find the mod ID in the URL: + https://www.nexusmods.com/skyrimspecialedition/mods/6194 + + :returns: The Nexus mod ID of Mod Organizer for this game. + + + + .. py:method:: primaryPlugins() -> Sequence[str] + + :returns: The list of plugins that are part of the game and not considered optional. + + + + .. py:method:: primarySources() -> Sequence[str] + + Retrieve primary alternative 'short' names for this game. + + This is used to determine if a Nexus (or other) download source should be considered + as a primary source for the game so that it is not flagged as an alternative one. + + :returns: The list of primary alternative 'short' names for this game, or an empty list. + + + + .. py:method:: savesDirectory() -> PyQt6.QtCore.QDir + :abstractmethod: + + + :returns: The directory where save games are stored. + + + + .. py:method:: secondaryDataDirectories() -> Dict[str, PyQt6.QtCore.QDir] + + Retrieve the list of secondary data directories. Each directories should be + assigned a unique name that differs from "data" which is the name of the main + data directory returned by dataDirectory(). + + :returns: A mapping from unique name to secondary data directories. + + + + .. py:method:: setGamePath(path: str) -> None + :abstractmethod: + + + Set the path to the managed game. + + This is called during instance creation if the game is not auto-detected and the user has + to specify the installation location. This is not called if the game has been auto-detected, + so `isInstalled()` should call this. + + :param path: Path to the game installation. + + + + .. py:method:: setGameVariant(variant: str) -> None + :abstractmethod: + + + Set the game variant. + + If there are multiple variants of game (as returned by `gameVariants()`), this will be + called on start with the user-selected game variant. + + :param variant: The game variant selected by the user. + + + + .. py:method:: sortMechanism() -> SortMechanism + + :returns: The sort mechanism for this game. + + + + .. py:method:: steamAPPId() -> str + + Retrieve the Steam app ID for this game. + + If the game is not available on Steam, this should return an empty string. + + If a game is available in multiple versions, those might have different app ids. The plugin + should try to return the right one + + :returns: The Steam app ID for this game. Should be empty for games not available on steam. + + + + .. py:method:: validShortNames() -> Sequence[str] + :abstractmethod: + + + Retrieve the valid 'short' names for this game. + + This is used to determine if a Nexus download is valid for the current game since not all + game variants have their own nexus pages and others can handle downloads from other nexus + game pages and should be allowed to do so (e.g., you can install some Skyrim LE mod even + when using Skyrim SE). + + The short name should be considered the primary handler for a directly supported game + for purposes of auto-launching an instance. + + :returns: The list of valid short names for this game. + + + +.. py:class:: IPluginInstaller + + Bases: :py:obj:`IPlugin` + + + This is the top-level class for installer. Actual installers should inherit either: + + - `IPluginInstallerSimple` if the installer can work directly with the archive. This is what + most installers use. + - `IPluginInstallerCustom` if the installer needs to perform custom operations. This is only + used by the external NCC installer and the OMOD installer. + + + .. py:method:: _manager() -> IInstallationManager + + :returns: The installation manager. + + + + .. py:method:: _parentWidget() -> PyQt6.QtWidgets.QWidget + + :returns: The parent widget. + + + + .. py:method:: isArchiveSupported(tree: IFileTree) -> bool + :abstractmethod: + + + Check if the given file tree corresponds to a supported archive for this installer. + + :param tree: The tree representing the content of the archive. + + :returns: True if this installer can handle the archive, False otherwise. + + + + .. py:method:: isManualInstaller() -> bool + :abstractmethod: + + + Check if this installer is a manual installer. + + :returns: True if this installer is a manual installer, False otherwise. + + + + .. py:method:: onInstallationEnd(result: InstallResult, new_mod: IModInterface) -> None + + Method calls at the end of the installation process. This method is only called once + per installation process, even for recursive installations (e.g. with the bundle installer). + + :param result: The result of the installation. + :param new_mod: If the installation succeeded (result is RESULT_SUCCESS), contains the newly + installed mod, otherwise it contains a null pointer. + + + + .. py:method:: onInstallationStart(archive: str, reinstallation: bool, current_mod: IModInterface) -> None + + Method calls at the start of the installation process, before any other methods. + This method is only called once per installation process, even for recursive + installations (e.g. with the bundle installer). + + If `reinstallation` is true, then the given mod is the mod being reinstalled (the one + selected by the user). If `reinstallation` is false and `currentMod` is not null, then + it corresponds to a mod MO2 thinks corresponds to the archive (e.g. based on matching Nexus ID + or name). + + The default implementation does nothing. + + :param archive: Path to the archive that is going to be installed. + :param reinstallation: True if this is a reinstallation, False otherwise. + :param current_mod: A currently installed mod corresponding to the archive being installed, or None + if there is no such mod. + + + + .. py:method:: priority() -> int + :abstractmethod: + + + Retrieve the priority of this installer. + + If multiple installers are able to handle an archive, the one with the highest priority wins. + + :returns: The priority of this installer. + + + + .. py:method:: setInstallationManager(manager: IInstallationManager) -> None + + Set the installation manager for this installer. + + Python plugins usually do not need to re-implement this and can directly access the installation + manager using `_manager()`. + + :param manager: The installation manager. + + + + .. py:method:: setParentWidget(parent: PyQt6.QtWidgets.QWidget) -> None + + Set the parent widget for this installer. + + Python plugins usually do not need to re-implement this and can directly access the parent + widget using `_parentWidget()` once the UI has been initialized. + + :param parent: The parent widget. + + + +.. py:class:: IPluginInstallerCustom + + Bases: :py:obj:`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. + + + .. py:method:: install(mod_name: GuessedString, game_name: str, archive_name: str, version: str, nexus_id: int) -> InstallResult + :abstractmethod: + + + Install the given archive. + + The mod needs to be created by calling `IOrganizer.createMod` first. + + :param 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). + :param game_name: Name of the game for which the mod is installed. + :param archive_name: Name of the archive to install. + :param 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. + :param 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. + + + + .. py:method:: isArchiveSupported(tree: IFileTree) -> bool + isArchiveSupported(archive_name: str) -> bool + :abstractmethod: + + + Check if the given file is a supported archive for this installer. + + :param archive_name: Name of the archive. + + :returns: True if this installer can handle the archive, False otherwise. + + + + .. py:method:: supportedExtensions() -> set[str] + :abstractmethod: + + + :returns: A list of file extensions that this installer can handle. + + + +.. py:class:: IPluginInstallerSimple + + Bases: :py:obj:`IPluginInstaller` + + + Simple installer for mods. Simple installers only deal with an in-memory structure + representing the archive and can modify what to install and where by editing this structure. + Actually extracting the archive is handled by the manager. + + + .. py:method:: install(name: GuessedString, tree: IFileTree, version: str, nexus_id: int) -> Union[InstallResult, IFileTree, tuple[InstallResult, IFileTree, str, int]] + :abstractmethod: + + + Install a mod from an archive filetree. + + The installer can modify the given tree and use the manager to extract or create new + files. + + This method returns different type of objects depending on the actual result of the + installation. The C++ bindings for this method always returns a tuple (result, tree, + version, id). + + :param 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). + :param tree: In-memory representation of the archive content. + :param version: Version of the mod, or an empty string is unknown. + :param nexus_id: ID of the mod, or -1 if unknown. + + :returns: In case of failure, the result of the installation, otherwise the modified tree or + + a tuple (result, tree, version, id) containing the result of the installation, the + modified tree, the new version and the new ID. The tuple can be returned even if the + installation did not succeed. + + + +.. py:class:: IPluginList + + Primary interface to the list of plugins. + + + .. py:method:: hasLightExtension(name: str) -> bool + + Determine if a plugin has a .esl extension. + + :param name: Filename of the plugin (without path but with file extension). + + :returns: True if the given file has a .esl extension, False otherwise or if the + + file does not exist. + + + + .. py:method:: hasMasterExtension(name: str) -> bool + + Determine if a plugin has a .esm extension. + + :param name: Filename of the plugin (without path but with file extension). + + :returns: True if the given file has a .esm extension, False otherwise or if the + + file does not exist. + + + + .. py:method:: hasNoRecords(name: str) -> bool + + Determine if a plugin has no records. + + :param name: Filename of the plugin (without path but with file extension). + + :returns: True if the given file plugin contains no records, False if it does OR if the + + file does not exist. + + + + .. py:method:: isLightFlagged(name: str) -> bool + + Determine if a plugin is flagged as light. + + In gamebryo games, a master file will usually have a .esl file extension but + technically an esp can be flagged as light. + + :param name: Filename of the plugin (without path but with file extension). + + :returns: True if the given plugin is a light plugin, False otherwise or if the + + file does not exist. + + + + .. py:method:: isMasterFlagged(name: str) -> bool + + Determine if a plugin is flagged as mater, i.e., a library, reference by + other plugins. + + In gamebryo games, a master file will usually have a .esm file extension but + technically an esp can be flagged as master and an esm might not be. + + :param name: Filename of the plugin (without path but with file extension). + + :returns: True if the given plugin is a master plugin, False otherwise or if the + + file does not exist. + + + + .. py:method:: isMediumFlagged(name: str) -> bool + + Determine if a plugin is flagged as medium. + + This plugin flag was added in Starfield and signifies plugin records that + update existing records + + :param name: Filename of the plugin (without path but with file extension). + + :returns: True if the given plugin is a medium plugin, False otherwise or if the + + file does not exist. + + + + .. py:method:: loadOrder(name: str) -> int + + Retrieve the load order of a plugin. + + :param name: Filename of the plugin (without path but with file extension). + + :returns: The load order of the plugin (the order in which the game loads it). If all plugins are enabled this + + is the same as the priority but disabled plugins will have a load order of -1. This also returns -1 + if the plugin does not exist. + + + + .. py:method:: masters(name: str) -> Sequence[str] + + Retrieve the list of masters required for a plugin. + + :param name: Filename of the plugin (without path but with file extension). + + :returns: The list of masters for the plugin (filenames with extension, no path). + + + + .. py:method:: onPluginMoved(callback: Callable[[str, int, int], None]) -> bool + + Install a new handler to be called when a plugin is moved. + + :param callback: The function to call when a plugin is moved. The first parameter is the plugin name, the + second the old priority of the plugin and the third one the new priority. + + :returns: True if the handler was installed properly (there are currently no reasons for this to fail). + + + + .. py:method:: onPluginStateChanged(callback: Callable[[dict[str, PluginState]], None]) -> bool + + Install a new handler to be called when plugin states change. + + :param callback: The function to call when a plugin states change. The parameter is a map from plugin names to new + plugin states for the plugin whose states have changed. + + :returns: True if the handler was installed properly (there are currently no reasons for this to fail). + + + + .. py:method:: onRefreshed(callback: Callable[[], None]) -> bool + + Install a new handler to be called when the list of plugins is refreshed. + + :param callback: The function to call when the list of plugins is refreshed. + + :returns: True if the handler was installed properly (there are currently no reasons for this to fail). + + + + .. py:method:: origin(name: str) -> str + + Retrieve the origin of a plugin. This is either the (internal) name of a mod, `"overwrite"` or `"data"`. + + The internal name of a mod can differ from the display name for disambiguation. + + :param name: Filename of the plugin (without path but with file extension). + + :returns: The name of the origin of the plugin, or an empty string if the plugin does not exist. + + + + .. py:method:: pluginNames() -> Sequence[str] + + :returns: The list of all plugin names. + + + + .. py:method:: priority(name: str) -> int + + Retrieve the priority of a plugin. + + The higher the priority, the more important. + + :param name: Filename of the plugin (without path but with file extension). + + :returns: The priority of the given plugin, or -1 if the plugin does not exist. + + + + .. py:method:: setLoadOrder(loadorder: Sequence[str]) -> None + + Set the load order. + + Plugins not included in the list will be placed at highest priority in the order they + were before. + + :param loadorder: The new load order, specified by the list of plugin names, sorted. + + + + .. py:method:: setPriority(name: str, priority: int) -> bool + + Change the priority of a plugin. + + :param name: Filename of the plugin (without path but with file extension). + :param priority: New priority of the plugin. + + :returns: True on success, False if the priority change was not possible. This is usually because + + one of the parameters is invalid. The function returns true even if the plugin was not moved + at the specified priority (e.g. when trying to move a non-master plugin before a master one). + + + + .. py:method:: setState(name: str, state: PluginState) -> None + + Set the state of a plugin. + + :param name: Filename of the plugin (without path but with file extension). + :param state: New state of the plugin (`INACTIVE` or `ACTIVE`). + + + + .. py:method:: state(name: str) -> PluginState + + Retrieve the state of a plugin. + + :param name: Filename of the plugin (without path but with file extension). + + :returns: The state of the plugin. + + + +.. py:class:: IPluginModPage + + Bases: :py:obj:`IPlugin` + + + Base class for all plugins. + + + .. py:method:: _parentWidget() -> PyQt6.QtWidgets.QWidget + + :returns: The parent widget. + + + + .. py:method:: displayName() -> str + :abstractmethod: + + + :returns: The name of the page as displayed in the UI. + + + + .. py:method:: handlesDownload(page_url: PyQt6.QtCore.QUrl, download_url: PyQt6.QtCore.QUrl, fileinfo: ModRepositoryFileInfo) -> bool + :abstractmethod: + + + Check if the plugin handles the specified download. + + :param page_url: URL of the page that contains the download link. + :param download_url: The download URL. + :param fileinfo: Not usable in python. + + :returns: True if this plugin wants to handle the specified download, False otherwise. + + + + .. py:method:: icon() -> PyQt6.QtGui.QIcon + :abstractmethod: + + + :returns: The icon to display with the page. + + + + .. py:method:: pageURL() -> PyQt6.QtCore.QUrl + :abstractmethod: + + + :returns: The URL to open when the user wants to visit this mod page. + + + + .. py:method:: setParentWidget(parent: PyQt6.QtWidgets.QWidget) -> None + + Set the parent widget for this mod page. + + Python plugins usually do not need to re-implement this and can directly access the parent + widget using `_parentWidget()` once the UI has been initialized. + + :param parent: The parent widget. + + + + .. py:method:: useIntegratedBrowser() -> bool + :abstractmethod: + + + Indicates if the page should be displayed in the integrated browser. + + Unless the page provides a special means of starting downloads (like the nxm:// url schema + on nexus), it will not be possible to handle downloads unless the integrated browser is used! + + :returns: True if the page should be opened in the integrated browser, False otherwise. + + + +.. py:class:: IPluginPreview + + Bases: :py:obj:`IPlugin` + + + These plugins add support for previewing files in the data pane. Right now all image formats supported + by qt are implemented (including dds) but no audio files and no 3d mesh formats. + + + .. py:method:: genDataPreview(file_data: PyQt6.QtCore.QByteArray, filename: str, max_size: PyQt6.QtCore.QSize) -> PyQt6.QtWidgets.QWidget + :abstractmethod: + + + Generate a preview widget from in-memory data. + + :param file_data: In-memory data to preview. + :param filename: Name of the file the data comes from. + :param max_size: Maximum size of the generated widget. + + :returns: The widget showing a preview of the in-memory data. + + + + .. py:method:: genFilePreview(filename: str, max_size: PyQt6.QtCore.QSize) -> PyQt6.QtWidgets.QWidget + :abstractmethod: + + + Generate a preview widget for the specified file. + + :param filename: Path to the file to preview. + :param max_size: Maximum size of the generated widget. + + :returns: The widget showing a preview of the file. + + + + .. py:method:: supportedExtensions() -> set[str] + :abstractmethod: + + + :returns: The list of file extensions that are supported by this preview plugin. + + + + .. py:method:: supportsArchives() -> bool + :abstractmethod: + + + Check if this preview plugin supports preview from in-memory data. + + :returns: True if the plugin supports preview from raw data, False otherwise. + + + +.. py:class:: IPluginRequirement + + Class representing requirements for plugins. + + + .. py:class:: Problem(short_description: str, long_description: str = '') + + Class representing a problem found by a requirement. + + + .. py:method:: longDescription() -> str + + :returns: A long description of the problem. + + + + .. py:method:: shortDescription() -> str + + :returns: A short description of the problem. + + + + + .. py:method:: check(organizer: IOrganizer) -> Optional[IPluginRequirement] + + Check if the requirement is met, and return a problem if not. + + :param organizer: The IOrganizer instance. + + :returns: The problem found if the requirement is not met, otherwise None. + + + +.. py:class:: IPluginTool + + Bases: :py:obj:`IPlugin` + + + This is the simplest of plugin interfaces. Such plugins simply place an icon inside the tools sub-menu + and get invoked when the user clicks it. They are expected to have a user interface of some sort. These + are almost like independent applications except they can access all Mod Organizer interfaces like querying + and modifying the current profile, mod list, load order, use MO to install mods and so on. A tool plugin + can (and should!) integrate its UI as a window inside MO and thus doesn't have to initialize a windows + application itself. + + + .. py:method:: _parentWidget() -> PyQt6.QtWidgets.QWidget + + :returns: The parent widget. + + + + .. py:method:: display() -> None + :abstractmethod: + + + Called when the user starts the tool. + + + + .. py:method:: displayName() -> str + :abstractmethod: + + + :returns: The display name for this tool, as shown in the tool menu. + + + + .. py:method:: icon() -> PyQt6.QtGui.QIcon + :abstractmethod: + + + :returns: The icon for this tool, or a default-constructed QICon(). + + + + .. py:method:: setParentWidget(parent: PyQt6.QtWidgets.QWidget) -> None + + Set the parent widget for this tool. + + Python plugins usually do not need to re-implement this and can directly access the parent + widget using `_parentWidget()` once the UI has been initialized. + + :param parent: The parent widget. + + + + .. py:method:: tooltip() -> str + :abstractmethod: + + + :returns: The tooltip for this tool. + + + +.. py:class:: IProfile + + Interface to interact with Mod Organizer 2 profiles. + + + .. py:method:: absoluteIniFilePath(inifile: str) -> str + + Retrieve the absolute file path to the corresponding INI file for this profile. + + If iniFile does not correspond to a file in the list of INI files for the + current game (as returned by IPluginGame::iniFiles), the path to the global + file will be returned (if iniFile is absolute, iniFile is returned, otherwise + the path is assumed relative to the game documents directory). + + :param inifile: INI file to retrieve a path for. This can either be the name of a file or a path to the + absolute file outside of the profile. + + :returns: The absolute path for the given INI file for this profile. + + + + .. py:method:: absolutePath() -> str + + :returns: The absolute path to the profile folder. + + + + .. py:method:: invalidationActive() -> tuple[bool, bool] + + :returns: True if automatic archive invalidation is enabled for this profile, False otherwise. + + + + .. py:method:: localSavesEnabled() -> bool + + :returns: True if profile-specific saves are enabled for this profile, False otherwise. + + + + .. py:method:: localSettingsEnabled() -> bool + + :returns: True if profile-specific game settings are enabled for this profile, False otherwise. + + + + .. py:method:: name() -> str + + :returns: The name of this profile. + + + +.. py:class:: ISaveGame + + Base class for information about what is in a save game. + + + .. py:method:: allFiles() -> Sequence[Union[str, os.PathLike[str], PyQt6.QtCore.QFileInfo]] + + :returns: The list of all files related to this save. + + + + .. py:method:: getCreationTime() -> PyQt6.QtCore.QDateTime + + Retrieve the creation time of the save. + + The creation time of a save is not always the same as the creation time of + the file containing the save. + + :returns: The creation time of the save. + + + + .. py:method:: getFilepath() -> Union[str, os.PathLike[str], PyQt6.QtCore.QFileInfo] + + :returns: The path name to the (main) file or folder for the save. + + + + .. py:method:: getName() -> str + + :returns: The name of this save, for display purpose. + + + + .. py:method:: getSaveGroupIdentifier() -> str + + Retrieve the name of the group this files belong to. + + The name can be used to identify sets of saves to transfer between profiles. For + RPG games, this is usually the name of a character. + + :returns: The group identifier for this save game. + + + +.. py:class:: ISaveGameInfoWidget(parent: PyQt6.QtWidgets.QWidget | None = None) + + Bases: :py:obj:`PyQt6.QtWidgets.QWidget` + + + Base class for a save game info widget. + + + .. py:method:: __getattr__(arg0: str) -> object + + + .. py:method:: _widget() -> PyQt6.QtWidgets.QWidget + + :returns: The underlying `QWidget`. + + + + .. py:method:: setSave(save: ISaveGame) -> None + :abstractmethod: + + + Set the save file to display in this widget. + + :param save: The save to display in the widget + + + +.. py:class:: InstallResult(*args, **kwds) + + Bases: :py:obj:`enum.Enum` + + + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + + + .. py:method:: __eq__(other: object) -> bool + + Return self==value. + + + + .. py:method:: __int__() -> int + + + .. py:method:: __ne__(other: object) -> bool + + Return self!=value. + + + + .. py:method:: __str__() -> str + + Return str(self). + + + + .. py:attribute:: CANCELED + :value: Ellipsis + + + + .. py:attribute:: FAILED + :value: Ellipsis + + + + .. py:attribute:: MANUAL_REQUESTED + :value: Ellipsis + + + + .. py:attribute:: NOT_ATTEMPTED + :value: Ellipsis + + + + .. py:attribute:: SUCCESS + :value: Ellipsis + + + + .. py:property:: name + :type: str + + The name of the Enum member. + + + .. py:property:: value + :type: int + + The value of the Enum member. + + +.. py:class:: LoadOrderMechanism(*args, **kwds) + + Bases: :py:obj:`enum.Enum` + + + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + + + .. py:method:: __eq__(other: object) -> bool + + Return self==value. + + + + .. py:method:: __int__() -> int + + + .. py:method:: __ne__(other: object) -> bool + + Return self!=value. + + + + .. py:method:: __str__() -> str + + Return str(self). + + + + .. py:attribute:: FILE_TIME + :value: Ellipsis + + + + .. py:attribute:: NONE + :value: Ellipsis + + + + .. py:attribute:: PLUGINS_TXT + :value: Ellipsis + + + + .. py:property:: name + :type: str + + The name of the Enum member. + + + .. py:property:: value + :type: int + + The value of the Enum member. + + +.. py:class:: LocalSavegames + + Bases: :py:obj:`GameFeature` + + + Base class for all game features, cannot be inherited, used only for typing + purpose in Python. + + + .. py:method:: mappings(profile_save_dir: PyQt6.QtCore.QDir) -> list[Mapping] + :abstractmethod: + + + + .. py:method:: prepareProfile(profile: IProfile) -> bool + :abstractmethod: + + + +.. py:class:: Mapping + Mapping(source: str, destination: str, is_directory: bool, create_target: bool = False) + + .. py:method:: __str__() -> str + + Return str(self). + + + + .. py:property:: createTarget + :type: bool + + + + .. py:property:: destination + :type: str + + + + .. py:property:: isDirectory + :type: bool + + + + .. py:property:: source + :type: str + + + +.. py:class:: ModDataChecker + + Bases: :py:obj:`GameFeature` + + + Game feature that is used to check the content of a data tree. + + + .. py:class:: CheckReturn(*args, **kwds) + + Bases: :py:obj:`enum.Enum` + + + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + + + .. py:method:: __eq__(other: object) -> bool + + Return self==value. + + + + .. py:method:: __int__() -> int + + + .. py:method:: __ne__(other: object) -> bool + + Return self!=value. + + + + .. py:method:: __str__() -> str + + Return str(self). + + + + .. py:attribute:: FIXABLE + :value: Ellipsis + + + + .. py:attribute:: INVALID + :value: Ellipsis + + + + .. py:attribute:: VALID + :value: Ellipsis + + + + .. py:property:: name + :type: str + + The name of the Enum member. + + + .. py:property:: value + :type: int + + The value of the Enum member. + + + + .. py:method:: dataLooksValid(filetree: IFileTree) -> ModDataChecker + :abstractmethod: + + + Check that the given filetree represent a valid mod layout, or can be easily + fixed. + + This method is mainly used during installation (to find which installer should + be used or to recurse into multi-level archives), or to quickly indicates to a + user if a mod looks valid. + + This method does not have to be exact, it only has to indicate if the given tree + looks like a valid mod or not by quickly checking the structure (heavy operations + should be avoided). + + If the tree can be fixed by the `fix()` method, this method should return `FIXABLE`. + `FIXABLE` should only be returned when it is guaranteed that `fix()` can fix the tree. + + :param filetree: The tree starting at the root of the "data" folder. + + :returns: Whether the tree is invalid, fixable or valid. + + + + .. py:method:: fix(filetree: IFileTree) -> IFileTree | None + + Try to fix the given tree. + + This method is used during installation to try to fix invalid archives and will only be + called if dataLooksValid returned `FIXABLE`. + + :param filetree: The tree to try to fix. Can be modified during the process. + + :returns: The fixed tree, or a null pointer if the tree could not be fixed. + + + + .. py:attribute:: FIXABLE + :type: ModDataChecker.CheckReturn + :value: Ellipsis + + + + .. py:attribute:: INVALID + :type: ModDataChecker.CheckReturn + :value: Ellipsis + + + + .. py:attribute:: VALID + :type: ModDataChecker.CheckReturn + :value: Ellipsis + + + +.. py:class:: ModDataContent + + Bases: :py:obj:`GameFeature` + + + The ModDataContent feature is used (when available) to indicate to users the content + of mods in the "Content" column. + + The feature exposes a list of possible content types, each associated with an ID, a name + and an icon. The icon is the path to either: + + - A Qt resource or; + - A file on the disk. + + In order to facilitate the implementation, MO2 already provides a set of icons that can + be used. Those icons are all under ``:/MO/gui/content`` (e.g. ``:/MO/gui/content/plugin`` or ``:/MO/gui/content/music`` `). + + The list of available icons is: + + - ``plugin``: |plugin-icon| + - ``skyproc``: |skyproc-icon| + - ``texture``: |texture-icon| + - ``music``: |music-icon| + - ``sound``: |sound-icon| + - ``interface``: |interface-icon| + - ``skse``: |skse-icon| + - ``script``: |script-icon| + - ``mesh``: |mesh-icon| + - ``string``: |string-icon| + - ``bsa``: |bsa-icon| + - ``menu``: |menu-icon| + - ``inifile``: |inifile-icon| + - ``modgroup``: |modgroup-icon| + + .. |plugin-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/jigsaw-piece.png + .. |skyproc-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/hand-of-god.png + .. |texture-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/empty-chessboard.png + .. |music-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/double-quaver.png + .. |sound-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/lyre.png + .. |interface-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/usable.png + .. |skse-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/checkbox-tree.png + .. |script-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/tinker.png + .. |mesh-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/breastplate.png + .. |string-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/conversation.png + .. |bsa-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/locked-chest.png + .. |menu-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/config.png + .. |inifile-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/feather-and-scroll.png + .. |modgroup-icon| image:: https://raw.githubusercontent.com/ModOrganizer2/modorganizer/master/src/resources/contents/xedit.png + + + .. py:class:: Content(id: int, name: str, icon: str, filter_only: bool = False) + + .. py:method:: isOnlyForFilter() -> bool + + :returns: True if this content is only meant to be used as a filter criteria. + + + + .. py:property:: icon + :type: str + + + + .. py:property:: id + :type: int + + + + .. py:property:: name + :type: str + + + + + .. py:method:: getAllContents() -> list[ModDataContent] + :abstractmethod: + + + :returns: The list of all possible contents for the corresponding game. + + + + .. py:method:: getContentsFor(filetree: IFileTree) -> list[int] + :abstractmethod: + + + Retrieve the list of contents in the given tree. + + :param filetree: The tree corresponding to the mod to retrieve contents for. + + :returns: The IDs of the content in the given tree. + + + +.. py:class:: ModRepositoryFileInfo(other: ModRepositoryFileInfo) + ModRepositoryFileInfo(game_name: str = '', mod_id: int = 0, file_id: int = 0) + + .. py:method:: __str__() -> str + + Return str(self). + + + + .. py:method:: createFromJson(data: str) -> ModRepositoryFileInfo + :staticmethod: + + + + .. py:property:: categoryID + :type: int + + + + .. py:property:: description + :type: str + + + + .. py:property:: fileCategory + :type: int + + + + .. py:property:: fileID + :type: int + + + + .. py:property:: fileName + :type: str + + + + .. py:property:: fileSize + :type: int + + + + .. py:property:: fileTime + :type: PyQt6.QtCore.QDateTime + + + + .. py:property:: gameName + :type: str + + + + .. py:property:: modID + :type: int + + + + .. py:property:: modName + :type: str + + + + .. py:property:: name + :type: str + + + + .. py:property:: newestVersion + :type: VersionInfo + + + + .. py:property:: repository + :type: str + + + + .. py:property:: uri + :type: str + + + + .. py:property:: userData + :type: MoVariant + + + + .. py:property:: version + :type: VersionInfo + + + +.. py:class:: ModState(*args, **kwds) + + Bases: :py:obj:`enum.Enum` + + + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + + + .. py:method:: __and__(other: ModState) -> ModState + + + .. py:method:: __eq__(other: object) -> bool + + Return self==value. + + + + .. py:method:: __ge__(other: ModState) -> bool + + Return self>=value. + + + + .. py:method:: __gt__(other: ModState) -> bool + + Return self>value. + + + + .. py:method:: __int__() -> int + + + .. py:method:: __invert__() -> ModState + + + .. py:method:: __le__(other: ModState) -> bool + + Return self<=value. + + + + .. py:method:: __lt__(other: ModState) -> bool + + Return self bool + + Return self!=value. + + + + .. py:method:: __or__(other: ModState) -> ModState + + + .. py:method:: __rand__(other: ModState) -> ModState + + + .. py:method:: __ror__(other: ModState) -> ModState + + + .. py:method:: __rxor__(other: ModState) -> ModState + + + .. py:method:: __str__() -> str + + Return str(self). + + + + .. py:method:: __xor__(other: ModState) -> ModState + + + .. py:attribute:: ACTIVE + :value: Ellipsis + + + + .. py:attribute:: ALTERNATE + :value: Ellipsis + + + + .. py:attribute:: EMPTY + :value: Ellipsis + + + + .. py:attribute:: ENDORSED + :value: Ellipsis + + + + .. py:attribute:: ESSENTIAL + :value: Ellipsis + + + + .. py:attribute:: EXISTS + :value: Ellipsis + + + + .. py:attribute:: VALID + :value: Ellipsis + + + + .. py:property:: name + :type: str + + The name of the Enum member. + + + .. py:property:: value + :type: int + + The value of the Enum member. + + +.. py:class:: PluginRequirementFactory + + .. py:method:: basic(checker: Callable[[IOrganizer], bool], description: str) -> IPluginRequirement + :staticmethod: + + + Create a basic requirement. + + :param checker: The callable to use to check if the requirement is met. Should return True + if the requirement is met, False otherwise. + :param description: The description of the problem, when the requirement is not met. + + :returns: The constructed requirement. + + + + .. py:method:: diagnose(diagnose: IPluginDiagnose) -> IPluginRequirement + :staticmethod: + + + Construct a requirement from a diagnose plugin. + + If the wrapped diagnose plugin reports a problem, the requirement fails + and the associated message is the one from the diagnose plugin (or the + list of messages if multiple problems were reported). + + :param diagnose: The diagnose plugin to wrap in this requirement. + + :returns: The constructed requirement. + + + + .. py:method:: gameDependency(games: Sequence[str]) -> IPluginRequirement + gameDependency(game: str) -> IPluginRequirement + :staticmethod: + + + Create a new game dependency requirement. + + The requirement is met when the managed game is the specified game. + + :param game: The name of the required game. + + :returns: The constructed requirement. + + + + .. py:method:: pluginDependency(plugins: Sequence[str]) -> IPluginRequirement + pluginDependency(plugin: str) -> IPluginRequirement + :staticmethod: + + + Create a new plugin dependency requirement. + + The requirement is met when the specified plugin is enabled. + + :param plugin: The name of the plugin that must be enabled. + + :returns: The constructed requirement. + + + +.. py:class:: PluginSetting(key: str, description: str, default_value: MoVariant) + + Class to hold the user-configurable parameters a plugin accepts. The purpose of this class is + only to inform the application what settings to offer to the user, it does not hold the actual value. + + + .. py:property:: default_value + :type: MoVariant + + + + .. py:property:: description + :type: str + + + + .. py:property:: key + :type: str + + + +.. py:class:: PluginState(*args, **kwds) + + Bases: :py:obj:`enum.Enum` + + + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + + + .. py:method:: __and__(other: PluginState) -> PluginState + + + .. py:method:: __eq__(other: object) -> bool + + Return self==value. + + + + .. py:method:: __ge__(other: PluginState) -> bool + + Return self>=value. + + + + .. py:method:: __gt__(other: PluginState) -> bool + + Return self>value. + + + + .. py:method:: __int__() -> int + + + .. py:method:: __invert__() -> PluginState + + + .. py:method:: __le__(other: PluginState) -> bool + + Return self<=value. + + + + .. py:method:: __lt__(other: PluginState) -> bool + + Return self bool + + Return self!=value. + + + + .. py:method:: __or__(other: PluginState) -> PluginState + + + .. py:method:: __rand__(other: PluginState) -> PluginState + + + .. py:method:: __ror__(other: PluginState) -> PluginState + + + .. py:method:: __rxor__(other: PluginState) -> PluginState + + + .. py:method:: __str__() -> str + + Return str(self). + + + + .. py:method:: __xor__(other: PluginState) -> PluginState + + + .. py:attribute:: ACTIVE + :value: Ellipsis + + + + .. py:attribute:: INACTIVE + :value: Ellipsis + + + + .. py:attribute:: MISSING + :value: Ellipsis + + + + .. py:property:: name + :type: str + + The name of the Enum member. + + + .. py:property:: value + :type: int + + The value of the Enum member. + + +.. py:class:: ProfileSetting(*args, **kwds) + + Bases: :py:obj:`enum.Enum` + + + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + + + .. py:method:: __and__(other: ProfileSetting) -> ProfileSetting + + + .. py:method:: __eq__(other: object) -> bool + + Return self==value. + + + + .. py:method:: __ge__(other: ProfileSetting) -> bool + + Return self>=value. + + + + .. py:method:: __gt__(other: ProfileSetting) -> bool + + Return self>value. + + + + .. py:method:: __int__() -> int + + + .. py:method:: __invert__() -> ProfileSetting + + + .. py:method:: __le__(other: ProfileSetting) -> bool + + Return self<=value. + + + + .. py:method:: __lt__(other: ProfileSetting) -> bool + + Return self bool + + Return self!=value. + + + + .. py:method:: __or__(other: ProfileSetting) -> ProfileSetting + + + .. py:method:: __rand__(other: ProfileSetting) -> ProfileSetting + + + .. py:method:: __ror__(other: ProfileSetting) -> ProfileSetting + + + .. py:method:: __rxor__(other: ProfileSetting) -> ProfileSetting + + + .. py:method:: __str__() -> str + + Return str(self). + + + + .. py:method:: __xor__(other: ProfileSetting) -> ProfileSetting + + + .. py:attribute:: CONFIGURATION + :value: Ellipsis + + + + .. py:attribute:: MODS + :value: Ellipsis + + + + .. py:attribute:: PREFER_DEFAULTS + :value: Ellipsis + + + + .. py:attribute:: SAVEGAMES + :value: Ellipsis + + + + .. py:property:: name + :type: str + + The name of the Enum member. + + + .. py:property:: value + :type: int + + The value of the Enum member. + + +.. py:class:: ReleaseType(*args, **kwds) + + Bases: :py:obj:`enum.Enum` + + + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + + + .. py:method:: __eq__(other: object) -> bool + + Return self==value. + + + + .. py:method:: __int__() -> int + + + .. py:method:: __ne__(other: object) -> bool + + Return self!=value. + + + + .. py:method:: __str__() -> str + + Return str(self). + + + + .. py:attribute:: ALPHA + :value: Ellipsis + + + + .. py:attribute:: BETA + :value: Ellipsis + + + + .. py:attribute:: CANDIDATE + :value: Ellipsis + + + + .. py:attribute:: FINAL + :value: Ellipsis + + + + .. py:attribute:: PRE_ALPHA + :value: Ellipsis + + + + .. py:property:: name + :type: str + + The name of the Enum member. + + + .. py:property:: value + :type: int + + The value of the Enum member. + + +.. py:class:: SaveGameInfo + + Bases: :py:obj:`GameFeature` + + + Feature to get hold of stuff to do with save games. + + + .. py:method:: getMissingAssets(save: ISaveGame) -> Dict[str, Sequence[str]] + :abstractmethod: + + + Retrieve missing assets from the save. + + :param save: The save to find missing assets for. + + :returns: A collection of missing assets and the modules that can supply those assets. + + + + .. py:method:: getSaveGameWidget(parent: PyQt6.QtWidgets.QWidget) -> ISaveGameInfoWidget | None + :abstractmethod: + + + Retrieve a widget to display over the save game list. + + This method is allowed to return `None` in case no widget has been implemented. + + :param parent: The parent widget. + + :returns: A SaveGameInfoWidget to display information about save game. + + + +.. py:class:: ScriptExtender + + Bases: :py:obj:`GameFeature` + + + Base class for all game features, cannot be inherited, used only for typing + purpose in Python. + + + .. py:method:: binaryName() -> str + :abstractmethod: + + + :returns: The name of the script extender binary. + + + + .. py:method:: getArch() -> int + :abstractmethod: + + + :returns: The CPU platform of the extender. + + + + .. py:method:: getExtenderVersion() -> str + :abstractmethod: + + + :returns: The version of the script extender. + + + + .. py:method:: isInstalled() -> bool + :abstractmethod: + + + :returns: True if the script extender is installed, False otherwise. + + + + .. py:method:: loaderName() -> str + :abstractmethod: + + + :returns: The loader to use to ensure the game runs with the script extender. + + + + .. py:method:: loaderPath() -> Union[str, os.PathLike[str], PyQt6.QtCore.QFileInfo] + :abstractmethod: + + + :returns: The full path to the script extender loader. + + + + .. py:method:: pluginPath() -> Union[str, os.PathLike[str], PyQt6.QtCore.QDir] + :abstractmethod: + + + :returns: The script extender plugin path, relative to the data folder. + + + + .. py:method:: savegameExtension() -> str + :abstractmethod: + + + Retrieve the extension of script extender save files. + + :returns: The extension of script extender save files (e.g. "skse"). + + + +.. py:class:: SortMechanism(*args, **kwds) + + Bases: :py:obj:`enum.Enum` + + + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + + + .. py:method:: __eq__(other: object) -> bool + + Return self==value. + + + + .. py:method:: __int__() -> int + + + .. py:method:: __ne__(other: object) -> bool + + Return self!=value. + + + + .. py:method:: __str__() -> str + + Return str(self). + + + + .. py:attribute:: BOSS + :value: Ellipsis + + + + .. py:attribute:: LOOT + :value: Ellipsis + + + + .. py:attribute:: MLOX + :value: Ellipsis + + + + .. py:attribute:: NONE + :value: Ellipsis + + + + .. py:property:: name + :type: str + + The name of the Enum member. + + + .. py:property:: value + :type: int + + The value of the Enum member. + + +.. py:class:: TrackedState(*args, **kwds) + + Bases: :py:obj:`enum.Enum` + + + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + + + .. py:method:: __eq__(other: object) -> bool + + Return self==value. + + + + .. py:method:: __ge__(other: TrackedState) -> bool + + Return self>=value. + + + + .. py:method:: __gt__(other: TrackedState) -> bool + + Return self>value. + + + + .. py:method:: __int__() -> int + + + .. py:method:: __le__(other: TrackedState) -> bool + + Return self<=value. + + + + .. py:method:: __lt__(other: TrackedState) -> bool + + Return self bool + + Return self!=value. + + + + .. py:method:: __str__() -> str + + Return str(self). + + + + .. py:attribute:: TRACKED_FALSE + :value: Ellipsis + + + + .. py:attribute:: TRACKED_TRUE + :value: Ellipsis + + + + .. py:attribute:: TRACKED_UNKNOWN + :value: Ellipsis + + + + .. py:property:: name + :type: str + + The name of the Enum member. + + + .. py:property:: value + :type: int + + The value of the Enum member. + + +.. py:class:: UnmanagedMods + + Bases: :py:obj:`GameFeature` + + + Base class for all game features, cannot be inherited, used only for typing + purpose in Python. + + + .. py:method:: displayName(mod_name: str) -> str + :abstractmethod: + + + Retrieve the display name of a given mod. + + :param mod_name: Internal name of the mod. + + :returns: The display name of the mod. + + + + .. py:method:: mods(official_only: bool) -> Sequence[str] + :abstractmethod: + + + Retrieve the list of unmanaged mods for the corresponding game. + + :param official_only: Retrieve only unmanaged official mods. + + :returns: The list of unmanaged mods (internal names). + + + + .. py:method:: referenceFile(mod_name: str) -> Union[str, os.PathLike[str], PyQt6.QtCore.QFileInfo] + :abstractmethod: + + + 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. + + :param mod_name: Internal name of the mod. + + :returns: The reference file (absolute path) for the requested mod. + + + + .. py:method:: secondaryFiles(mod_name: str) -> Sequence[Union[str, os.PathLike[str], PyQt6.QtCore.QFileInfo]] + :abstractmethod: + + + Retrieve the secondary files for the requested mod. + + Example: For Bethesda games, the secondary files may be the archives + corresponding to the reference file. + + :param mod_name: Internal name of the mod. + + :returns: The secondary files (absolute paths) for the request mod. + + + +.. py:class:: VersionInfo + VersionInfo(value: str, scheme: VersionScheme = VersionScheme.DISCOVER) + VersionInfo(major: int, minor: int, subminor: int, subsubminor: int, release_type: ReleaseType = ReleaseType.FINAL) + VersionInfo(major: int, minor: int, subminor: int, release_type: ReleaseType = ReleaseType.FINAL) + + Represents the version of a mod or plugin. + + + .. py:method:: __eq__(other: object) -> bool + + Return self==value. + + + + .. py:method:: __ge__(arg0: VersionInfo) -> bool + + Return self>=value. + + + + .. py:method:: __gt__(arg0: VersionInfo) -> bool + + Return self>value. + + + + .. py:method:: __le__(arg0: VersionInfo) -> bool + + Return self<=value. + + + + .. py:method:: __lt__(arg0: VersionInfo) -> bool + + Return self bool + + Return self!=value. + + + + .. py:method:: __str__() -> str + + :returns: See `canonicalString()`. + + + + .. py:method:: canonicalString() -> str + + :returns: A canonical string representing this version, that can be stored and then parsed using the parse() method. + + + + .. py:method:: clear() -> None + + Resets this VersionInfo to an invalid version. + + + + .. py:method:: displayString(forced_segments: int = 2) -> str + + :param forced_segments: The number of version segments to display even if the version is 0. 1 is major, 2 is major + and minor, etc. The only implemented ranges are (-inf,2] for major/minor, [3] for major/minor/subminor, + and [4,inf) for major/minor/subminor/subsubminor. This only versions with a regular scheme. + + :returns: A string for display to the user. The returned string may not contain enough information to reconstruct this version info. + + + + .. py:method:: isValid() -> bool + + :returns: True if this VersionInfo is valid, False otherwise. + + + + .. py:method:: parse(value: str, scheme: VersionScheme = VersionScheme.DISCOVER, is_manual: bool = False) -> None + + Update this VersionInfo by parsing the given string using the given scheme. + + :param value: String to parse. + :param scheme: Scheme to use to parse the string. + :param is_manual: True if the given string should be treated as user input. + + + + .. py:method:: scheme() -> VersionScheme + + :returns: The version scheme in effect for this VersionInfo. + + + +.. py:class:: VersionScheme(*args, **kwds) + + Bases: :py:obj:`enum.Enum` + + + Create a collection of name/value pairs. + + Example enumeration: + + >>> class Color(Enum): + ... RED = 1 + ... BLUE = 2 + ... GREEN = 3 + + Access them by: + + - attribute access: + + >>> Color.RED + + + - value lookup: + + >>> Color(1) + + + - name lookup: + + >>> Color['RED'] + + + Enumerations can be iterated over, and know how many members they have: + + >>> len(Color) + 3 + + >>> list(Color) + [, , ] + + Methods can be added to enumerations, and members can have their own + attributes -- see the documentation for details. + + + .. py:method:: __eq__(other: object) -> bool + + Return self==value. + + + + .. py:method:: __int__() -> int + + + .. py:method:: __ne__(other: object) -> bool + + Return self!=value. + + + + .. py:method:: __str__() -> str + + Return str(self). + + + + .. py:attribute:: DATE + :value: Ellipsis + + + + .. py:attribute:: DECIMAL_MARK + :value: Ellipsis + + + + .. py:attribute:: DISCOVER + :value: Ellipsis + + + + .. py:attribute:: LITERAL + :value: Ellipsis + + + + .. py:attribute:: NUMBERS_AND_LETTERS + :value: Ellipsis + + + + .. py:attribute:: REGULAR + :value: Ellipsis + + + + .. py:property:: name + :type: str + + The name of the Enum member. + + + .. py:property:: value + :type: int + + The value of the Enum member. + + +.. py:function:: getFileVersion(filepath: Union[str, os.PathLike[str], PyQt6.QtCore.QFileInfo]) -> str + + Retrieve the file version of the given executable. + + :param filepath: Absolute path to the executable. + + :returns: The file version, or an empty string if the file version could not be retrieved. + + +.. py:function:: getIconForExecutable(executable: Union[str, os.PathLike[str], PyQt6.QtCore.QFileInfo]) -> PyQt6.QtGui.QIcon + + Retrieve the icon of an executable. Currently this always extracts the biggest icon. + + :param executable: Absolute path to the executable. + + :returns: The icon for this executable, if any. + + +.. py:function:: getProductVersion(executable: Union[str, os.PathLike[str], PyQt6.QtCore.QFileInfo]) -> str + + Retrieve the product version of the given executable. + + :param executable: Absolute path to the executable. + + :returns: The product version, or an empty string if the product version could not be retrieved. + + +.. py:data:: GameFeatureType + +.. py:data:: INVALID_HANDLE_VALUE + :type: int + :value: Ellipsis + + +.. py:data:: MoVariant + +.. py:data:: __version__ + :value: '2.5.2' + + diff --git a/_sources/autoapi/mobase/widgets/index.rst.txt b/_sources/autoapi/mobase/widgets/index.rst.txt new file mode 100644 index 0000000..fc50d14 --- /dev/null +++ b/_sources/autoapi/mobase/widgets/index.rst.txt @@ -0,0 +1,142 @@ +mobase.widgets +============== + +.. py:module:: mobase.widgets + + +Attributes +---------- + +.. autoapisummary:: + + mobase.widgets.__version__ + + +Classes +------- + +.. autoapisummary:: + + mobase.widgets.TaskDialog + mobase.widgets.TaskDialogButton + + +Package Contents +---------------- + +.. py:class:: TaskDialog(parent: PyQt6.QtWidgets.QWidget | None = None, title: str = '', main: str = '', content: str = '', details: str = '', icon: PyQt6.QtWidgets.QMessageBox.Icon = PyQt6.QtWidgets.QMessageBox.Icon.NoIcon, buttons: list[TaskDialogButton] = [], remember: Union[str, tuple[str, str]] = '') + + Customizable choice dialog. + + + .. py:method:: addButton(button: TaskDialogButton) -> TaskDialog + + Add a custom button to this TaskDialog. + + :param button: Button to add to the dialog. + + + + .. py:method:: addContent(widget: PyQt6.QtWidgets.QWidget) -> None + + Add a custom widget content to this TaskDialog. Widget content are put between + content and buttons (above buttons). + + :param widget: Widget to add. + + + + .. py:method:: exec() -> PyQt6.QtWidgets.QMessageBox.StandardButton + + Display this dialog and wait for user-interaction to return. This is a blocking + function. + + :returns: The button clicked by the user. Without custom buttons, this return Ok, + + otherwise it returns the button set in the TaskDialogButton. + + + + .. py:method:: setContent(content: str) -> TaskDialog + + Set the top-level message of this dialog. + + :param content: Top-level message to set. + + + + .. py:method:: setDetails(details: str) -> TaskDialog + + Set the details for this TaskDialog. + + The details are hidden by default and the user can display them by clicking + the "Details" button at the bottom of the TaskDialog. + + :param details: Details content to display. Can be a multi-line string. + + + + .. py:method:: setIcon(icon: PyQt6.QtWidgets.QMessageBox.Icon) -> TaskDialog + + Set the icon of the dialog. + + :param icon: Icon of the dialog. + + + + .. py:method:: setMain(main: str) -> TaskDialog + + Set the main message of the dialog. The main message is displayed at the top of + the dialog in large font. + + :param main: Main message of the dialog. + + + + .. py:method:: setRemember(action: str, file: str = '') -> TaskDialog + + Configure the dialog to remember user-choice. + + + + .. py:method:: setTitle(title: str) -> TaskDialog + + Set the title of the dialog. + + :param title: Title of the dialog. + + + + .. py:method:: setWidth(width: int) -> None + + Set the width of the dialog. + + :param width: Width of the dialog. + + + +.. py:class:: TaskDialogButton(text: str, description: str, button: PyQt6.QtWidgets.QMessageBox.StandardButton) + TaskDialogButton(text: str, button: PyQt6.QtWidgets.QMessageBox.StandardButton) + + Special button to be used inside TaskDialog widgets. + + + .. py:property:: button + :type: PyQt6.QtWidgets.QMessageBox.StandardButton + + + + .. py:property:: description + :type: str + + + + .. py:property:: text + :type: str + + + +.. py:data:: __version__ + :value: '2.5.2' + + diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt index ef93b56..1249aeb 100644 --- a/_sources/index.rst.txt +++ b/_sources/index.rst.txt @@ -18,7 +18,6 @@ This documentation is dedicated to writting MO2 **Python** plugins. plugin-types writing-plugins faq - mobase diff --git a/_sources/mobase.rst.txt b/_sources/mobase.rst.txt deleted file mode 100644 index 26a456f..0000000 --- a/_sources/mobase.rst.txt +++ /dev/null @@ -1,11 +0,0 @@ -``mobase`` API -============== - -.. currentmodule:: mobase - -.. automodapi:: mobase - :no-inheritance-diagram: - :no-heading: - -.. toctree:: - :maxdepth: 4 diff --git a/_sources/modules.rst.txt b/_sources/modules.rst.txt deleted file mode 100644 index 2b6dad5..0000000 --- a/_sources/modules.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -mobase -====== - -.. toctree:: - :maxdepth: 4 - - mobase diff --git a/api/mobase.BSAInvalidation.html b/api/mobase.BSAInvalidation.html deleted file mode 100644 index e89b7bf..0000000 --- a/api/mobase.BSAInvalidation.html +++ /dev/null @@ -1,459 +0,0 @@ - - - - - - - BSAInvalidation — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

BSAInvalidation

-
-
-class mobase.BSAInvalidation
-

Bases: GameFeature

-

Methods Summary

- - - - - - - - - - - - -

activate(profile)

deactivate(profile)

isInvalidationBSA(name)

-

Methods Documentation

-
-
-abstract activate(profile)
-
-
Return type:
-

None

-
-
-
- -
-
-abstract deactivate(profile)
-
-
Return type:
-

None

-
-
-
- -
-
-abstract isInvalidationBSA(name)
-
-
Return type:
-

bool

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.DataArchives.html b/api/mobase.DataArchives.html deleted file mode 100644 index 66f99db..0000000 --- a/api/mobase.DataArchives.html +++ /dev/null @@ -1,501 +0,0 @@ - - - - - - - DataArchives — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

DataArchives

-
-
-class mobase.DataArchives
-

Bases: GameFeature

-

Methods Summary

- - - - - - - - - - - - - - - -

addArchive(profile, index, name)

Add an archive to the archive list.

archives(profile)

Retrieve the list of archives in the given profile.

removeArchive(profile, name)

Remove the given archive from the given profile.

vanillaArchives()

Retrieve the list of vanilla archives.

-

Methods Documentation

-
-
-abstract addArchive(profile, index, name)
-

Add an archive to the archive list.

-
-
Return type:
-

None

-
-
Parameters:
-
    -

  • profile – Profile to add the archive to.

    • -

  • index – Index to insert before. Use 0 for the beginning of the list or INT_MAX for -the end of the list).

    • -

  • name – Name of the archive to add.

    • -
-
-
-
- -
-
-abstract archives(profile)
-

Retrieve the list of archives in the given profile.

-
-
Return type:
-

Sequence[str]

-
-
Parameters:
-

profile – Profile to retrieve archives from.

-
-
Returns:
-

The list of archives in the given profile.

-
-
-
- -
-
-abstract removeArchive(profile, name)
-

Remove the given archive from the given profile.

-
-
Return type:
-

None

-
-
Parameters:
-
    -

  • profile – Profile to remove the archive from.

    • -

  • name – Name of the archive to remove.

    • -
-
-
-
- -
-
-abstract vanillaArchives()
-

Retrieve the list of vanilla archives.

-

Vanilla archives are archive files that are shipped with the original -game.

-
-
Return type:
-

Sequence[str]

-
-
Returns:
-

The list of vanilla archives.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.EndorsedState.html b/api/mobase.EndorsedState.html deleted file mode 100644 index 532e712..0000000 --- a/api/mobase.EndorsedState.html +++ /dev/null @@ -1,468 +0,0 @@ - - - - - - - EndorsedState — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

EndorsedState

-
-
-class mobase.EndorsedState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
-

Bases: Enum

-

Attributes Summary

- - - - - - - - - - - - - - - - - - - - - -

ENDORSED_FALSE

ENDORSED_NEVER

ENDORSED_TRUE

ENDORSED_UNKNOWN

name

value

-

Attributes Documentation

-
-
-ENDORSED_FALSE = None
-
- -
-
-ENDORSED_NEVER = None
-
- -
-
-ENDORSED_TRUE = None
-
- -
-
-ENDORSED_UNKNOWN = None
-
- -
-
-name
-
- -
-
-value
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.ExecutableForcedLoadSetting.html b/api/mobase.ExecutableForcedLoadSetting.html deleted file mode 100644 index 74d699e..0000000 --- a/api/mobase.ExecutableForcedLoadSetting.html +++ /dev/null @@ -1,498 +0,0 @@ - - - - - - - ExecutableForcedLoadSetting — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

ExecutableForcedLoadSetting

-
-
-class mobase.ExecutableForcedLoadSetting(process, library)
-

Bases: object

-

Methods Summary

- - - - - - - - - - - - - - - - - - - - - -

enabled()

forced()

library()

process()

withEnabled(enabled)

withForced(forced)

-

Methods Documentation

-
-
-enabled()
-
-
Return type:
-

bool

-
-
-
- -
-
-forced()
-
-
Return type:
-

bool

-
-
-
- -
-
-library()
-
-
Return type:
-

str

-
-
-
- -
-
-process()
-
-
Return type:
-

str

-
-
-
- -
-
-withEnabled(enabled)
-
-
Return type:
-

ExecutableForcedLoadSetting

-
-
-
- -
-
-withForced(forced)
-
-
Return type:
-

ExecutableForcedLoadSetting

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.ExecutableInfo.html b/api/mobase.ExecutableInfo.html deleted file mode 100644 index 22056cd..0000000 --- a/api/mobase.ExecutableInfo.html +++ /dev/null @@ -1,563 +0,0 @@ - - - - - - - ExecutableInfo — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

ExecutableInfo

-
-
-class mobase.ExecutableInfo(title, binary)
-

Bases: object

-

Methods Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

arguments()

asCustom()

binary()

isCustom()

isValid()

steamAppID()

title()

withArgument(argument)

withSteamAppId(app_id)

withWorkingDirectory(directory)

workingDirectory()

-

Methods Documentation

-
-
-arguments()
-
-
Return type:
-

Sequence[str]

-
-
-
- -
-
-asCustom()
-
-
Return type:
-

ExecutableInfo

-
-
-
- -
-
-binary()
-
-
Return type:
-

QFileInfo

-
-
-
- -
-
-isCustom()
-
-
Return type:
-

bool

-
-
-
- -
-
-isValid()
-
-
Return type:
-

bool

-
-
-
- -
-
-steamAppID()
-
-
Return type:
-

str

-
-
-
- -
-
-title()
-
-
Return type:
-

str

-
-
-
- -
-
-withArgument(argument)
-
-
Return type:
-

ExecutableInfo

-
-
-
- -
-
-withSteamAppId(app_id)
-
-
Return type:
-

ExecutableInfo

-
-
-
- -
-
-withWorkingDirectory(directory)
-
-
Return type:
-

ExecutableInfo

-
-
-
- -
-
-workingDirectory()
-
-
Return type:
-

QDir

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.FileInfo.html b/api/mobase.FileInfo.html deleted file mode 100644 index 19ff9bc..0000000 --- a/api/mobase.FileInfo.html +++ /dev/null @@ -1,445 +0,0 @@ - - - - - - - FileInfo — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

FileInfo

-
-
-class mobase.FileInfo
-

Bases: object

-

Information about a virtualized file

-

Attributes Summary

- - - - - - - - - - - - -

archive

filePath

origins

-

Attributes Documentation

-
-
-archive
-
- -
-
-filePath
-
- -
-
-origins
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.FileTreeEntry.html b/api/mobase.FileTreeEntry.html deleted file mode 100644 index 19f9f71..0000000 --- a/api/mobase.FileTreeEntry.html +++ /dev/null @@ -1,649 +0,0 @@ - - - - - - - FileTreeEntry — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

FileTreeEntry

-
-
-class mobase.FileTreeEntry
-

Bases: object

-

Represent an entry in a file tree, either a file or a directory. This class -inherited by IFileTree so that operations on entry are the same for a file or -a directory.

-

This class provides convenience methods to query information on the file, like its -name or the its last modification time. It also provides a convenience astree() method -that can be used to retrieve the tree corresponding to its entry in case the entry -represent a directory.

-

Attributes Summary

- - - - - - - - - - - - -

DIRECTORY

FILE

FILE_OR_DIRECTORY

-

Methods Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

detach()

Detach this entry from its parent tree.

fileType()

hasSuffix(**kwds)

Helper for @overload to raise when called.

isDir()

isFile()

moveTo(tree)

Move this entry to the given tree.

name()

parent()

path([sep])

Retrieve the path from this entry up to the root of the tree.

pathFrom(tree[, sep])

Retrieve the path from the given tree to this entry.

suffix()

Retrieve the "last" extension of this entry.

-

Attributes Documentation

-
-
-DIRECTORY: FileTypes = Ellipsis
-
- -
-
-FILE: FileTypes = Ellipsis
-
- -
-
-FILE_OR_DIRECTORY: FileTypes = Ellipsis
-
- -

Methods Documentation

-
-
-detach()
-

Detach this entry from its parent tree.

-
-
Return type:
-

bool

-
-
Returns:
-

True if the entry was removed correctly, False otherwise.

-
-
-
- -
-
-fileType()
-
-
Return type:
-

FileTypes

-
-
Returns:
-

The filetype of this entry.

-
-
-
- -
-
-hasSuffix(**kwds)
-

Helper for @overload to raise when called.

-
- -
-
-isDir()
-
-
Return type:
-

bool

-
-
Returns:
-

True if this entry is a directory, False otherwise.

-
-
-
- -
-
-isFile()
-
-
Return type:
-

bool

-
-
Returns:
-

True if this entry is a file, False otherwise.

-
-
-
- -
-
-moveTo(tree)
-

Move this entry to the given tree.

-
-
Return type:
-

bool

-
-
Parameters:
-

tree – The tree to move this entry to.

-
-
Returns:
-

True if the entry was moved correctly, False otherwise.

-
-
-
- -
-
-name()
-
-
Return type:
-

str

-
-
Returns:
-

The name of this entry.

-
-
-
- -
-
-parent()
-
-
Return type:
-

IFileTree | None

-
-
Returns:
-

The parent tree containing this entry, or a None if this entry is the root

-
-
-

or the parent tree is unreachable.

-
- -
-
-path(sep='\\\\')
-

Retrieve the path from this entry up to the root of the tree.

-

This method propagate up the tree so is not constant complexity as -the full path is never stored.

-
-
Return type:
-

str

-
-
Parameters:
-

sep – The type of separator to use to create the path.

-
-
Returns:
-

The path from this entry to the root, including the name of this entry.

-
-
-
- -
-
-pathFrom(tree, sep='\\\\')
-

Retrieve the path from the given tree to this entry.

-
-
Return type:
-

str

-
-
Parameters:
-
    -

  • tree – The tree to reach, must be a parent of this entry.

    • -

  • sep – The type of separator to use to create the path.

    • -
-
-
Returns:
-

The path from the given tree to this entry, including the name of this entry, or

-
-
-

an empty string if the given tree is not a parent of this entry.

-
- -
-
-suffix()
-

Retrieve the “last” extension of this entry.

-

The “last” extension is everything after the last dot in the file name.

-
-
Return type:
-

str

-
-
Returns:
-

The last extension of this entry, or an empty string if the file has no extension

-
-
-

or is directory.

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.GameFeature.html b/api/mobase.GameFeature.html deleted file mode 100644 index 634d2f8..0000000 --- a/api/mobase.GameFeature.html +++ /dev/null @@ -1,416 +0,0 @@ - - - - - - - GameFeature — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

GameFeature

-
-
-class mobase.GameFeature
-

Bases: ABC

-

Base class for all game features, cannot be inherited, used only for typing -purpose in Python.

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.GamePlugins.html b/api/mobase.GamePlugins.html deleted file mode 100644 index 14c9084..0000000 --- a/api/mobase.GamePlugins.html +++ /dev/null @@ -1,491 +0,0 @@ - - - - - - - GamePlugins — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

GamePlugins

-
-
-class mobase.GamePlugins
-

Bases: GameFeature

-

Methods Summary

- - - - - - - - - - - - - - - - - - -

getLoadOrder()

lightPluginsAreSupported()

mediumPluginsAreSupported()

readPluginLists(plugin_list)

writePluginLists(plugin_list)

-

Methods Documentation

-
-
-abstract getLoadOrder()
-
-
Return type:
-

Sequence[str]

-
-
-
- -
-
-abstract lightPluginsAreSupported()
-
-
Return type:
-

bool

-
-
Returns:
-

True if light plugins are supported, False otherwise.

-
-
-
- -
-
-abstract mediumPluginsAreSupported()
-
-
Return type:
-

bool

-
-
Returns:
-

True if medium plugins are supported, False otherwise.

-
-
-
- -
-
-abstract readPluginLists(plugin_list)
-
-
Return type:
-

None

-
-
-
- -
-
-abstract writePluginLists(plugin_list)
-
-
Return type:
-

None

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.GuessQuality.html b/api/mobase.GuessQuality.html deleted file mode 100644 index f379488..0000000 --- a/api/mobase.GuessQuality.html +++ /dev/null @@ -1,486 +0,0 @@ - - - - - - - GuessQuality — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

GuessQuality

-
-
-class mobase.GuessQuality(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
-

Bases: Enum

-

Describes how good the code considers a guess (i.e. for a mod name) this is used to -determine if a name from another source should overwrite or not.

-

Attributes Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - -

FALLBACK

GOOD

INVALID

META

PRESET

USER

name

value

-

Attributes Documentation

-
-
-FALLBACK = None
-
- -
-
-GOOD = None
-
- -
-
-INVALID = None
-
- -
-
-META = None
-
- -
-
-PRESET = None
-
- -
-
-USER = None
-
- -
-
-name
-
- -
-
-value
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.GuessedString.html b/api/mobase.GuessedString.html deleted file mode 100644 index a73a459..0000000 --- a/api/mobase.GuessedString.html +++ /dev/null @@ -1,479 +0,0 @@ - - - - - - - GuessedString — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

GuessedString

-
-
-class mobase.GuessedString
-
-class mobase.GuessedString(value: str, quality: GuessQuality = GuessQuality.USER)
-

Bases: object

-

Represents a string that may be set from different places. Each time the value is -changed a “quality” is specified to say how probable it is the value is the best choice. -Only the best choice should be used in the end but alternatives can be queried. This -class also allows a filter to be set. If a “guess” doesn’t pass the filter, it is ignored.

-

Methods Summary

- - - - - - - - - - - - - - - -

reset(**kwds)

Helper for @overload to raise when called.

setFilter(filter)

Set the filter for this GuessedString.

update(**kwds)

Helper for @overload to raise when called.

variants()

-

Methods Documentation

-
-
-reset(**kwds)
-

Helper for @overload to raise when called.

-
- -
-
-setFilter(filter)
-

Set the filter for this GuessedString.

-

The filter is applied on every update() and can reject the new value -altogether or modify it (by returning a new value).

-
-
Return type:
-

None

-
-
Parameters:
-

filter – The new filter.

-
-
-
- -
-
-update(**kwds)
-

Helper for @overload to raise when called.

-
- -
-
-variants()
-
-
Return type:
-

set[str]

-
-
Returns:
-

The list of variants for this GuessedString.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.IDownloadManager.html b/api/mobase.IDownloadManager.html deleted file mode 100644 index 7ea792d..0000000 --- a/api/mobase.IDownloadManager.html +++ /dev/null @@ -1,567 +0,0 @@ - - - - - - - IDownloadManager — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

IDownloadManager

-
-
-class mobase.IDownloadManager
-

Bases: object

-

Methods Summary

- - - - - - - - - - - - - - - - - - - - - - - - -

downloadPath(id)

Retrieve the (absolute) path of the specified download.

onDownloadComplete(callback)

Installs a handler to be called when a download completes.

onDownloadFailed(callback)

Installs a handler to be called when a download fails.

onDownloadPaused(callback)

Installs a handler to be called when a download is paused.

onDownloadRemoved(callback)

Installs a handler to be called when a download is removed.

startDownloadNexusFile(mod_id, file_id)

Download a file from www.nexusmods.com/<game>.

startDownloadURLs(urls)

Download a file by url.

-

Methods Documentation

-
-
-downloadPath(id)
-

Retrieve the (absolute) path of the specified download.

-
-
Return type:
-

str

-
-
Parameters:
-

id – ID of the download.

-
-
Returns:
-

The absolute path to the file corresponding to the given download. This file

-
-
-

may not exist yet if the download is incomplete.

-
- -
-
-onDownloadComplete(callback)
-

Installs a handler to be called when a download completes.

-
-
Return type:
-

bool

-
-
Parameters:
-

callback – The function to be called when a download complete. The parameter is the download ID.

-
-
Returns:
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
-
- -
-
-onDownloadFailed(callback)
-

Installs a handler to be called when a download fails.

-
-
Return type:
-

bool

-
-
Parameters:
-

callback – The function to be called when a download fails. The parameter is the download ID.

-
-
Returns:
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
-
- -
-
-onDownloadPaused(callback)
-

Installs a handler to be called when a download is paused.

-
-
Return type:
-

bool

-
-
Parameters:
-

callback – The function to be called when a download is paused. The parameter is the download ID.

-
-
Returns:
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
-
- -
-
-onDownloadRemoved(callback)
-

Installs a handler to be called when a download is removed.

-
-
Return type:
-

bool

-
-
Parameters:
-

callback – The function to be called when a download is removed. The parameter is the download ID.

-
-
Returns:
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
-
- -
-
-startDownloadNexusFile(mod_id, file_id)
-

Download a file from www.nexusmods.com/<game>. <game> is always the game -currently being managed.

-
-
Return type:
-

int

-
-
Parameters:
-
    -

  • mod_id – ID of the mod to download the file from.

    • -

  • file_id – ID of the file to download.

    • -
-
-
Returns:
-

An ID identifying the download.

-
-
-
- -
-
-startDownloadURLs(urls)
-

Download a file by url.

-

The list can contain alternative URLs to allow the download manager to switch -in case of download problems

-
-
Return type:
-

int

-
-
Parameters:
-

urls – List of urls to download from.

-
-
Returns:
-

An ID identifying the download.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.IFileTree.html b/api/mobase.IFileTree.html deleted file mode 100644 index d763500..0000000 --- a/api/mobase.IFileTree.html +++ /dev/null @@ -1,896 +0,0 @@ - - - - - - - IFileTree — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

IFileTree

-
-
-class mobase.IFileTree
-

Bases: FileTreeEntry

-

Interface to classes that provides way to visualize and alter file trees. The tree -may not correspond to an actual file tree on the disk (e.g., inside an archive, -from a QTree Widget, …).

-

Read-only operations on the tree are thread-safe, even when the tree has not been populated -yet.

-

In order to prevent wrong usage of the tree, implementing classes may throw -UnsupportedOperationException if an operation is not supported. By default, all operations -are supported, but some may not make sense in many situations.

-

The goal of this is not reflect the change made to a IFileTree to the disk, but child -classes may override relevant methods to do so.

-

The tree is built upon FileTreeEntry. A given tree holds shared pointers to its entries -while each entry holds a weak pointer to its parent, this means that the descending link -are strong (shared pointers) but the uplink are weak.

-

Accessing the parent is always done by locking the weak pointer so that returned pointer -or either null or valid. This structure implies that as long as the initial root lives, -entry should not be destroyed, unless the entry are detached from the root and no shared -pointers are kept.

-

However, it is not guarantee that one can go up the tree from a single node entry. If the -root node is destroyed, it will not be possible to go up the tree, even if we still have -a valid shared pointer.

-

Attributes Summary

- - - - - - - - - - - - - - - - - - - - - -

CONTINUE

FAIL_IF_EXISTS

MERGE

REPLACE

SKIP

STOP

-

Methods Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

addDirectory(path)

Create a new directory tree under this tree.

addFile(path[, replace_if_exists])

Create a new file directly under this tree.

clear()

Delete (detach) all the entries from this tree.

copy(entry[, path, insert_policy])

Move the given entry to the given path under this tree.

createOrphanTree([name])

Create a new orphan empty tree.

exists(path[, type])

Check if the given entry exists.

find(path[, type])

Retrieve the given entry.

insert(entry[, policy])

Insert the given entry in this tree, removing it from its previous parent.

merge(other[, overwrites])

Merge the given tree with this tree, i.e., insert all entries of the given tree into this tree.

move(entry, path[, policy])

Move the given entry to the given path under this tree.

pathTo(entry[, sep])

Retrieve the path from this tree to the given entry.

remove(**kwds)

Helper for @overload to raise when called.

removeAll(names)

Delete the entries with the given names from the tree.

removeIf(filter)

Delete entries matching the given predicate from the tree.

walk(callback[, sep])

Walk this tree, calling the given function for each entry in it.

-

Attributes Documentation

-
-
-CONTINUE: WalkReturn = Ellipsis
-
- -
-
-FAIL_IF_EXISTS: InsertPolicy = Ellipsis
-
- -
-
-MERGE: InsertPolicy = Ellipsis
-
- -
-
-REPLACE: InsertPolicy = Ellipsis
-
- -
-
-SKIP: WalkReturn = Ellipsis
-
- -
-
-STOP: WalkReturn = Ellipsis
-
- -

Methods Documentation

-
-
-addDirectory(path)
-

Create a new directory tree under this tree.

-

This method will create missing folders in the given path and will -not fail if the directory already exists but will fail if the given -path contains “.” or “..”. -This method invalidates iterators to this tree and all the subtrees -present in the given path.

-
-
Return type:
-

IFileTree

-
-
Parameters:
-

path – Path to the directory to create.

-
-
Returns:
-

An IFileTree corresponding to the created directory.

-
-
Raises:
-

RuntimeError – If the directory could not be created.

-
-
-
- -
-
-addFile(path, replace_if_exists=False)
-

Create a new file directly under this tree.

-

This method will fail if the file already exists and replace_if_exists is False. -This method invalidates iterators to this tree and all the subtrees present in the -given path.

-
-
Return type:
-

FileTreeEntry

-
-
Parameters:
-
    -

  • path – Path to the file to create.

    • -

  • replace_if_exists – If True and an entry already exists at the given location, it will be replaced by -a new entry. This will replace both files and directories.

    • -
-
-
Returns:
-

A FileTreeEntry corresponding to the created file.

-
-
Raises:
-

RuntimeError – If the file could not be created.

-
-
-
- -
-
-clear()
-

Delete (detach) all the entries from this tree.

-

This method will go through the entries in this tree and stop at the first -entry that cannot be deleted, this means that the tree can be partially cleared.

-
-
Return type:
-

bool

-
-
Returns:
-

True if all entries have been detached, False otherwise.

-
-
-
- -
-
-copy(entry, path='', insert_policy=InsertPolicy.None)
-

Move the given entry to the given path under this tree.

-

The entry must not be a parent tree of this tree. This method can also be used -to rename entries.

-

If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry -at the same location already exists. If the policy is REPLACE, an existing -entry will be replaced. If MERGE, the entry will be merged with the existing -one (if the entry is a file, and a file exists, the file will be replaced).

-

This method invalidates iterator to this tree, to the parent tree of the given -entry, and to subtrees of this tree if the insert policy is MERGE.

-
-
Return type:
-

FileTreeEntry

-
-
Parameters:
-
    -

  • entry – Entry to copy.

    • -

  • path – The path to copy the entry to. If the path ends with / or , the entry will -be copied in the corresponding directory instead of replacing it. If the -given path is empty (“”), the entry is copied directly under this tree.

    • -

  • insert_policy – Policy to use to resolve conflicts.

    • -
-
-
Returns:
-

The new entry (copy of the specified entry).

-
-
Raises:
-

RuntimeError – If the entry could not be copied.

-
-
-
- -
-
-createOrphanTree(name='')
-

Create a new orphan empty tree.

-
-
Return type:
-

IFileTree

-
-
Parameters:
-

name – Name of the tree.

-
-
Returns:
-

A new tree without any parent.

-
-
-
- -
-
-exists(path, type=FileTypes.None)
-

Check if the given entry exists.

-
-
Return type:
-

bool

-
-
Parameters:
-
    -

  • path – Path to the entry, separated by / or .

    • -

  • type – The type of the entry to check.

    • -
-
-
Returns:
-

True if the entry was found, False otherwise.

-
-
-
- -
-
-find(path, type=FileTypes.None)
-

Retrieve the given entry.

-

If no entry exists at the given path, or if the entry is not of the right -type, None is returned.

-
-
Return type:
-

IFileTree | FileTreeEntry | None

-
-
Parameters:
-
    -

  • path – Path to the entry, separated by / or .

    • -

  • type – The type of the entry to check.

    • -
-
-
Returns:
-

The entry at the given location, or None if the entry was not found or

-
-
-

was not of the correct type.

-
- -
-
-insert(entry, policy=InsertPolicy.None)
-

Insert the given entry in this tree, removing it from its -previous parent.

-

The entry must not be this tree or a parent entry of this tree. -:rtype: bool

-
-
    -

  • If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry -with the same name already exists.

    • -

  • If the policy is REPLACE, an existing entry will be replaced by the given entry.

    • -

  • If the policy is MERGE:

    -
      -

    • If there is no entry with the same name, the new entry is inserted.

      • -

    • If there is an entry with the same name:

      -
        -

      • If both entries are files, the old file is replaced by the given entry.

        • -

      • If both entries are directories, a merge is performed as if using merge().

        • -

      • Otherwise the insertion fails (two entries with different types).

        • -
      -
      • -
    -
    • -
-
-

This method invalidates iterator to this tree, to the parent tree of the given -entry, and to subtrees of this tree if the insert policy is MERGE.

-
-
Parameters:
-
    -

  • entry – Entry to insert.

    • -

  • policy – Policy to use to resolve conflicts.

    • -
-
-
Returns:
-

True if the entry was insert, False otherwise.

-
-
-
- -
-
-merge(other, overwrites=False)
-

Merge the given tree with this tree, i.e., insert all entries -of the given tree into this tree.

-

The tree must not be this tree or a parent entry of this tree. Files present in both tree -will be replaced by files in the given tree. After a merge, the source tree will be -empty but still attached to its parent.

-

If overwrites is True, a map from overridden files to new files will be returned.

-

Note that the merge process makes no distinction between files and directories -when merging: if a directory is present in this tree and a file from source -is in conflict with it, the tree will be removed and the file inserted; if a file -is in this tree and a directory from source is in conflict with it, the file will -be replaced with the directory.

-

This method invalidates iterators to this tree, all the subtrees under this tree -present in the given path, and all the subtrees of the given source.

-
-
Return type:
-

Union[dict[FileTreeEntry, FileTreeEntry], int]

-
-
Parameters:
-
    -

  • other – Tree to merge.

    • -

  • overwrites – If True, a mapping from overridden files to new files will be returned.

    • -
-
-
Returns:
-

If overwrites is True, a mapping from overridden files to new files, otherwise

-
-
-

the number of overwritten entries.

-
-
Raises:
-

RuntimeError – If the merge failed.

-
-
-
- -
-
-move(entry, path, policy=InsertPolicy.None)
-

Move the given entry to the given path under this tree.

-

The entry must not be a parent tree of this tree. This method can also be used -to rename entries.

-

If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry -at the same location already exists. If the policy is REPLACE, an existing -entry will be replaced. If MERGE, the entry will be merged with the existing -one (if the entry is a file, and a file exists, the file will be replaced).

-

This method invalidates iterator to this tree, to the parent tree of the given -entry, and to subtrees of this tree if the insert policy is MERGE.

-
-
Return type:
-

bool

-
-
Parameters:
-
    -

  • entry – Entry to move.

    • -

  • path – The path to move the entry to. If the path ends with / or , the entry will -be inserted in the corresponding directory instead of replacing it. If the -given path is empty (“”), this is equivalent to insert().

    • -

  • policy – Policy to use to resolve conflicts.

    • -
-
-
Returns:
-

True if the entry was moved correctly, False otherwise.

-
-
-
- -
-
-pathTo(entry, sep='\\\\')
-

Retrieve the path from this tree to the given entry.

-
-
Return type:
-

str

-
-
Parameters:
-
    -

  • entry – The entry to reach, must be in this tree.

    • -

  • sep – The type of separator to use to create the path.

    • -
-
-
Returns:
-

The path from this tree to the given entry, including the name of the entry, or

-
-
-

an empty string if the given entry was not found under this tree.

-
- -
-
-remove(**kwds)
-

Helper for @overload to raise when called.

-
- -
-
-removeAll(names)
-

Delete the entries with the given names from the tree.

-

This method does not recurse into subtrees, so only entries accessible -directly from this tree will be removed. This method invalidates iterators.

-
-
Return type:
-

int

-
-
Parameters:
-

names – Names of the entries to delete.

-
-
Returns:
-

The number of deleted entry.

-
-
-
- -
-
-removeIf(filter)
-

Delete entries matching the given predicate from the tree.

-

This method does not recurse into subtrees, so only entries accessible -directly from this tree will be removed. This method invalidates iterators.

-
-
Return type:
-

int

-
-
Parameters:
-

filter – Predicate that should return true for entries to delete.

-
-
Returns:
-

The number of deleted entry.

-
-
-
- -
-
-walk(callback, sep='\\\\')
-

Walk this tree, calling the given function for each entry in it.

-

The given callback will be called with two parameters: the path from this tree to the given entry -(with a trailing separator, not including the entry name), and the actual entry. The method returns -a WalkReturn object to indicates what to do.

-
-
Return type:
-

None

-
-
Parameters:
-
    -

  • callback – Method to call for each entry in the tree.

    • -

  • sep – Type of separator to use to construct the path.

    • -
-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.IGameFeatures.html b/api/mobase.IGameFeatures.html deleted file mode 100644 index f1560bb..0000000 --- a/api/mobase.IGameFeatures.html +++ /dev/null @@ -1,494 +0,0 @@ - - - - - - - IGameFeatures — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

IGameFeatures

-
-
-class mobase.IGameFeatures
-

Bases: object

-

Interface for the game features, accessible through IOrganizer.gameFeatures().

-

Methods Summary

- - - - - - - - - - - - - - - -

gameFeature(feature_type)

Retrieve the given game feature, if one exists.

registerFeature(**kwds)

Helper for @overload to raise when called.

unregisterFeature(feature)

Unregister the given game feature.

unregisterFeatures(feature_type)

Unregister all features of the given type registered by the calling plugin.

-

Methods Documentation

-
-
-gameFeature(feature_type)
-

Retrieve the given game feature, if one exists.

-
-
Return type:
-

TypeVar(GameFeatureType)

-
-
Parameters:
-

feature_type – The class of feature to retrieve.

-
-
Returns:
-

The game feature corresponding to the given type, or None if the feature is

-
-
-

not available.

-
- -
-
-registerFeature(**kwds)
-

Helper for @overload to raise when called.

-
- -
-
-unregisterFeature(feature)
-

Unregister the given game feature.

-

This function is safe to use even if the given feature was never registered.

-
-
Return type:
-

bool

-
-
Parameters:
-

feature – Feature to unregister.

-
-
Returns:
-

True if the feature was successfully unregistered, False otherwise.

-
-
-
- -
-
-unregisterFeatures(feature_type)
-

Unregister all features of the given type registered by the calling plugin.

-

This function is safe to use even if the plugin has no feature of the given type -register.

-
-
Return type:
-

int

-
-
Parameters:
-

feature_type – The class of feature to unregister.

-
-
Returns:
-

The number of unregistered features.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.IInstallationManager.html b/api/mobase.IInstallationManager.html deleted file mode 100644 index 40d350a..0000000 --- a/api/mobase.IInstallationManager.html +++ /dev/null @@ -1,543 +0,0 @@ - - - - - - - IInstallationManager — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

IInstallationManager

-
-
-class mobase.IInstallationManager
-

Bases: object

-

Methods Summary

- - - - - - - - - - - - - - - - - - -

createFile(entry)

Create a new file on the disk corresponding to the given entry.

extractFile(entry[, silent])

Extract the specified file from the currently opened archive to a temporary location.

extractFiles(entries[, silent])

Extract the specified files from the currently opened archive to a temporary location.

getSupportedExtensions()

installArchive(mod_name, archive[, mod_id])

Install the given archive.

-

Methods Documentation

-
-
-createFile(entry)
-

Create a new file on the disk corresponding to the given entry.

-

This method can be used by installer that needs to create files that are not in the original -archive. At the end of the installation, if there are entries in the final tree that were used -to create files, the corresponding files will be moved to the mod folder.

-

Temporary files corresponding to created files are automatically cleaned up at the end of -the installation.

-
-
Return type:
-

str

-
-
Parameters:
-

entry – The entry for which a temporary file should be created.

-
-
Returns:
-

The path to the created file, or an empty string if the file could not be created.

-
-
-
- -
-
-extractFile(entry, silent=False)
-

Extract the specified file from the currently opened archive to a temporary -location.

-

This method cannot be used to extract directory.

-

The call will fail with an exception if no archive is open (plugins deriving from -IPluginInstallerSimple can rely on that, custom installers should not). The temporary -file is automatically cleaned up after the installation. This call can be very slow -if the archive is large and “solid”.

-
-
Return type:
-

str

-
-
Parameters:
-
    -

  • entry – Entry corresponding to the file to extract.

    • -

  • silent – If true, the dialog showing extraction progress will not be shown.

    • -
-
-
Returns:
-

The absolute path to the temporary file, or an empty string if the file was not extracted.

-
-
-
- -
-
-extractFiles(entries, silent=False)
-

Extract the specified files from the currently opened archive to a temporary -location.

-

This method cannot be used to extract directories.

-

The call will fail with an exception if no archive is open (plugins deriving from -IPluginInstallerSimple can rely on that, custom installers should not). The temporary -files are automatically cleaned up after the installation. This call can be very slow -if the archive is large and “solid”.

-
-
Return type:
-

Sequence[str]

-
-
Parameters:
-
    -

  • entries – Entries corresponding to the files to extract.

    • -

  • silent – If true, the dialog showing extraction progress will not be shown.

    • -
-
-
Returns:
-

A list containing absolute paths to the temporary files.

-
-
-
- -
-
-getSupportedExtensions()
-
-
Return type:
-

Sequence[str]

-
-
Returns:
-

The extensions of archives supported by this installation manager.

-
-
-
- -
-
-installArchive(mod_name, archive, mod_id=0)
-

Install the given archive.

-
-
Return type:
-

tuple[InstallResult, str, int]

-
-
Parameters:
-
    -

  • mod_name – Suggested name of the mod.

    • -

  • archive – Path to the archive to install.

    • -

  • mod_id – ID of the mod, if available.

    • -
-
-
Returns:
-

The result of the installation.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.IModInterface.html b/api/mobase.IModInterface.html deleted file mode 100644 index 8c5929a..0000000 --- a/api/mobase.IModInterface.html +++ /dev/null @@ -1,1070 +0,0 @@ - - - - - - - IModInterface — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

IModInterface

-
-
-class mobase.IModInterface
-

Bases: object

-

Methods Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

absolutePath()

addCategory(name)

Assign a category to the mod.

addNexusCategory(category_id)

Set the category id from a nexus category id.

categories()

clearPluginSettings(plugin_name)

Remove all the settings of the specified plugin this mod.

color()

comments()

converted()

Check if the mod was marked as converted by the user.

endorsedState()

fileTree()

Retrieve a file tree corresponding to the underlying disk content of this mod.

gameName()

Retrieve the short name of the game associated with this mod.

ignoredVersion()

installationFile()

isBackup()

isForeign()

isOverwrite()

isSeparator()

name()

newestVersion()

nexusId()

notes()

pluginSetting(plugin_name, key[, default])

Retrieve the specified setting in this mod for a plugin.

pluginSettings(plugin_name)

Retrieve the settings in this mod for a plugin.

primaryCategory()

removeCategory(name)

Unassign a category from this mod.

repository()

setGameName(name)

Set the source game of this mod.

setIsEndorsed(endorsed)

Set endorsement state of the mod.

setNewestVersion(version)

Set the latest known version of this mod.

setNexusID(nexus_id)

Set the Nexus ID of this mod.

setPluginSetting(plugin_name, key, value)

Set the specified setting in this mod for a plugin.

setUrl(url)

Set the URL of this mod.

setVersion(version)

Set the version of this mod.

trackedState()

url()

validated()

Check if the mod was marked as validated by the user.

version()

-

Methods Documentation

-
-
-absolutePath()
-
-
Return type:
-

str

-
-
Returns:
-

Absolute path to the mod to be used in file system operations.

-
-
-
- -
-
-addCategory(name)
-

Assign a category to the mod. If the named category does not exist it is created.

-
-
Return type:
-

None

-
-
Parameters:
-

name – Name of the new category to assign.

-
-
-
- -
-
-addNexusCategory(category_id)
-

Set the category id from a nexus category id. Conversion to MO ID happens internally.

-

If a mapping is not possible, the category is set to the default value.

-
-
Return type:
-

None

-
-
Parameters:
-

category_id – The Nexus category ID.

-
-
-
- -
-
-categories()
-
-
Return type:
-

Sequence[str]

-
-
Returns:
-

The list of categories this mod belongs to.

-
-
-
- -
-
-clearPluginSettings(plugin_name)
-

Remove all the settings of the specified plugin this mod.

-
-
Return type:
-

dict[str, None | bool | int | str | list[object] | dict[str, object]]

-
-
Parameters:
-

plugin_name – Name of the plugin for which settings should be removed. This should always be IPlugin.name() -unless you have a really good reason to access settings of another plugin.

-
-
Returns:
-

The old settings from the given plugin, as returned by pluginSettings().

-
-
-
- -
-
-color()
-
-
Return type:
-

QColor

-
-
Returns:
-

The color of the ‘Notes’ column chosen by the user.

-
-
-
- -
-
-comments()
-
-
Return type:
-

str

-
-
Returns:
-

The comments for this mod, if any.

-
-
-
- -
-
-converted()
-

Check if the mod was marked as converted by the user.

-

When a mod is for a different game, a flag is shown to users to warn them, but -they can mark mods as converted to remove this flag.

-
-
Return type:
-

bool

-
-
Returns:
-

True if this mod was marked as converted by the user.

-
-
-
- -
-
-endorsedState()
-
-
Return type:
-

EndorsedState

-
-
Returns:
-

The endorsement state of this mod.

-
-
-
- -
-
-fileTree()
-

Retrieve a file tree corresponding to the underlying disk content of this mod.

-

The file tree should not be cached by plugins since it is already and updated when -required.

-
-
Return type:
-

IFileTree

-
-
Returns:
-

A file tree representing the content of this mod.

-
-
-
- -
-
-gameName()
-

Retrieve the short name of the game associated with this mod. This may differ -from the current game plugin (e.g. you can install a Skyrim LE game in a SSE -installation).

-
-
Return type:
-

str

-
-
Returns:
-

The name of the game associated with this mod.

-
-
-
- -
-
-ignoredVersion()
-
-
Return type:
-

VersionInfo

-
-
Returns:
-

The ignored version of this mod (for update), or an invalid version if the user

-
-
-

did not ignore version for this mod.

-
- -
-
-installationFile()
-
-
Return type:
-

str

-
-
Returns:
-

The absolute path to the file that was used to install this mod.

-
-
-
- -
-
-isBackup()
-
-
Return type:
-

bool

-
-
Returns:
-

True if this mod represents a backup.

-
-
-
- -
-
-isForeign()
-
-
Return type:
-

bool

-
-
Returns:
-

True if this mod represents a foreign mod, not managed by MO2.

-
-
-
- -
-
-isOverwrite()
-
-
Return type:
-

bool

-
-
Returns:
-

True if this mod represents the overwrite mod.

-
-
-
- -
-
-isSeparator()
-
-
Return type:
-

bool

-
-
Returns:
-

True if this mod represents a separator.

-
-
-
- -
-
-name()
-
-
Return type:
-

str

-
-
Returns:
-

The name of this mod.

-
-
-
- -
-
-newestVersion()
-
-
Return type:
-

VersionInfo

-
-
Returns:
-

The newest version of this mod (as known by MO2). If this matches version(),

-
-
-

then the mod is up-to-date.

-
- -
-
-nexusId()
-
-
Return type:
-

int

-
-
Returns:
-

The Nexus ID of this mod.

-
-
-
- -
-
-notes()
-
-
Return type:
-

str

-
-
Returns:
-

The notes for this mod, if any.

-
-
-
- -
-
-pluginSetting(plugin_name, key, default=None)
-

Retrieve the specified setting in this mod for a plugin.

-
-
Return type:
-

None | bool | int | str | list[object] | dict[str, object]

-
-
Parameters:
-
    -

  • plugin_name – Name of the plugin for which to retrieve a setting. This should always be IPlugin.name() -unless you have a really good reason to access settings of another plugin.

    • -

  • key – Identifier of the setting.

    • -

  • default – The default value to return if the setting does not exist.

    • -
-
-
Returns:
-

The setting, if found, or the default value.

-
-
-
- -
-
-pluginSettings(plugin_name)
-

Retrieve the settings in this mod for a plugin.

-
-
Return type:
-

dict[str, None | bool | int | str | list[object] | dict[str, object]]

-
-
Parameters:
-

plugin_name – Name of the plugin for which to retrieve settings. This should always be IPlugin.name() -unless you have a really good reason to access settings of another plugin.

-
-
Returns:
-

A map from setting key to value. The map is empty if there are not settings for this mod.

-
-
-
- -
-
-primaryCategory()
-
-
Return type:
-

int

-
-
Returns:
-

The ID of the primary category of this mod.

-
-
-
- -
-
-removeCategory(name)
-

Unassign a category from this mod.

-
-
Return type:
-

bool

-
-
Parameters:
-

name – Name of the category to remove.

-
-
Returns:
-

True if the category was removed, False otherwise (e.g. if no such category

-
-
-

was assigned).

-
- -
-
-repository()
-
-
Return type:
-

str

-
-
Returns:
-

The name of the repository from which this mod was installed.

-
-
-
- -
-
-setGameName(name)
-

Set the source game of this mod.

-
-
Return type:
-

None

-
-
Parameters:
-

name – The new source game short name of this mod.

-
-
-
- -
-
-setIsEndorsed(endorsed)
-

Set endorsement state of the mod.

-
-
Return type:
-

None

-
-
Parameters:
-

endorsed – New endorsement state of this mod.

-
-
-
- -
-
-setNewestVersion(version)
-

Set the latest known version of this mod.

-
-
Return type:
-

None

-
-
Parameters:
-

version – The latest known version of this mod.

-
-
-
- -
-
-setNexusID(nexus_id)
-

Set the Nexus ID of this mod.

-
-
Return type:
-

None

-
-
Parameters:
-

nexus_id – Thew new Nexus ID of this mod.

-
-
-
- -
-
-setPluginSetting(plugin_name, key, value)
-

Set the specified setting in this mod for a plugin.

-
-
Return type:
-

bool

-
-
Parameters:
-
    -

  • plugin_name – Name of the plugin for which to retrieve a setting. This should always be IPlugin.name() -unless you have a really good reason to access settings of another plugin.

    • -

  • key – Identifier of the setting.

    • -

  • value – New value for the setting to set.

    • -
-
-
Returns:
-

True if the setting was set correctly, False otherwise.

-
-
-
- -
-
-setUrl(url)
-

Set the URL of this mod.

-
-
Return type:
-

None

-
-
Parameters:
-

url – The URL of this mod.

-
-
-
- -
-
-setVersion(version)
-

Set the version of this mod.

-
-
Return type:
-

None

-
-
Parameters:
-

version – The new version of this mod.

-
-
-
- -
-
-trackedState()
-
-
Return type:
-

TrackedState

-
-
Returns:
-

The tracked state of this mod.

-
-
-
- -
-
-url()
-
-
Return type:
-

str

-
-
Returns:
-

The URL of this mod, or an empty QString() if no URL is associated

-
-
-

with this mod.

-
- -
-
-validated()
-

Check if the mod was marked as validated by the user.

-

MO2 uses ModDataChecker to check the content of mods, but sometimes these fail, in -which case mods are incorrectly marked as ‘not containing valid games data’. Users can -choose to mark these mods as valid to hide the warning / flag.

-
-
Return type:
-

bool

-
-
Returns:
-

True if th is mod was marked as containing valid game data.

-
-
-
- -
-
-version()
-
-
Return type:
-

VersionInfo

-
-
Returns:
-

The current version of this mod.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.IModList.html b/api/mobase.IModList.html deleted file mode 100644 index de43164..0000000 --- a/api/mobase.IModList.html +++ /dev/null @@ -1,703 +0,0 @@ - - - - - - - IModList — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

IModList

-
-
-class mobase.IModList
-

Bases: object

-

Interface to the mod-list.

-

All api functions in this interface work need the internal name of a mod to find a -mod. For regular mods (mods the user installed) the display name (as shown to the user) -and internal name are identical. For other mods (non-MO mods) there is currently no way -to translate from display name to internal name because the display name might not me un-ambiguous.

-

Methods Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

allMods()

allModsByProfilePriority([profile])

displayName(name)

Retrieve the display name of a mod from its internal name.

getMod(name)

Retrieve an interface to a mod using its name.

onModInstalled(callback)

Install a new handler to be called when a new mod is installed.

onModMoved(callback)

Install a handler to be called when a mod is moved.

onModRemoved(callback)

Install a new handler to be called when a mod is removed.

onModStateChanged(callback)

Install a handler to be called when mod states change (enabled/disabled, endorsed, ...).

priority(name)

Retrieve the priority of a mod.

removeMod(mod)

Remove a mod (from disc and from the UI).

renameMod(mod, name)

Rename the given mod.

setActive(**kwds)

Helper for @overload to raise when called.

setPriority(name, priority)

Change the priority of a mod.

state(name)

Retrieve the state of a mod.

-

Methods Documentation

-
-
-allMods()
-
-
Return type:
-

Sequence[str]

-
-
Returns:
-

A list containing the internal names of all installed mods.

-
-
-
- -
-
-allModsByProfilePriority(profile=None)
-
-
Return type:
-

Sequence[str]

-
-
Returns:
-

The list of mod (names), sorted according to the current profile priorities.

-
-
-
- -
-
-displayName(name)
-

Retrieve the display name of a mod from its internal name.

-

If you received an internal name from the API (e.g. IPluginList.origin) then you should use -that name to identify the mod in all other api calls but use this function to retrieve the name -to show to the user.

-
-
Return type:
-

str

-
-
Parameters:
-

name – Internal name of the mod.

-
-
Returns:
-

The display name of the given mod.

-
-
-
- -
-
-getMod(name)
-

Retrieve an interface to a mod using its name.

-
-
Return type:
-

IModInterface

-
-
Parameters:
-

name – Name of the mod to retrieve.

-
-
Returns:
-

An interface to the given mod, or None if there is no mod with this name.

-
-
-
- -
-
-onModInstalled(callback)
-

Install a new handler to be called when a new mod is installed.

-
-
Return type:
-

bool

-
-
Parameters:
-

callback – The function to call when a mod is installed. The parameter of the function is the name of the -newly installed mod.

-
-
Returns:
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
-
- -
-
-onModMoved(callback)
-

Install a handler to be called when a mod is moved.

-
-
Return type:
-

bool

-
-
Parameters:
-

callback – The function to call when a mod is moved. The first argument is the internal name of the -mod, the second argument the old priority and the third argument the new priority.

-
-
Returns:
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
-
- -
-
-onModRemoved(callback)
-

Install a new handler to be called when a mod is removed.

-
-
Return type:
-

bool

-
-
Parameters:
-

callback – The function to call when a mod is removed. The parameter of the function is the name of the -removed mod.

-
-
Returns:
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
-
- -
-
-onModStateChanged(callback)
-

Install a handler to be called when mod states change (enabled/disabled, endorsed, …).

-
-
Return type:
-

bool

-
-
Parameters:
-

callback – The function to call when the states of mod change. The argument is a map containing the -mods whose states have changed. Keys are internal mod names and values are mod states.

-
-
Returns:
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
-
- -
-
-priority(name)
-

Retrieve the priority of a mod.

-
-
Return type:
-

int

-
-
Parameters:
-

name – Internal name of the mod.

-
-
Returns:
-

The priority of the given mod.

-
-
-
- -
-
-removeMod(mod)
-

Remove a mod (from disc and from the UI).

-
-
Return type:
-

bool

-
-
Parameters:
-

mod – The mod to remove.

-
-
Returns:
-

True if the mod was removed, False otherwise.

-
-
-
- -
-
-renameMod(mod, name)
-

Rename the given mod.

-

This method usually invalidates the given mod so you should use the returned value -after calling it instead of the passed value.

-
-
Return type:
-

IModInterface

-
-
Parameters:
-
    -

  • mod – The mod to rename.

    • -

  • name – The new name of the mod.

    • -
-
-
Returns:
-

A valid reference to the given mod after renaming it.

-
-
-
- -
-
-setActive(**kwds)
-

Helper for @overload to raise when called.

-
- -
-
-setPriority(name, priority)
-

Change the priority of a mod.

-

priority is the new priority after the move. Keep in mind that the mod disappears from its -old location and all mods with higher priority than the moved mod decrease in priority by one.

-
-
Return type:
-

bool

-
-
Parameters:
-
    -

  • name – Internal name of the mod.

    • -

  • priority – The new priority of the mod.

    • -
-
-
Returns:
-

True if the priority was changed, False otherwise (if the name or priority were invalid).

-
-
-
- -
-
-state(name)
-

Retrieve the state of a mod.

-
-
Return type:
-

ModState

-
-
Parameters:
-

name – Internal name of the mod.

-
-
Returns:
-

The state of the given mod.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.IModRepositoryBridge.html b/api/mobase.IModRepositoryBridge.html deleted file mode 100644 index 5030ea6..0000000 --- a/api/mobase.IModRepositoryBridge.html +++ /dev/null @@ -1,605 +0,0 @@ - - - - - - - IModRepositoryBridge — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

IModRepositoryBridge

-
-
-class mobase.IModRepositoryBridge
-

Bases: QObject

-

Attributes Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

descriptionAvailable

downloadURLsAvailable

endorsementToggled

endorsementsAvailable

fileInfoAvailable

filesAvailable

requestFailed

trackedModsAvailable

trackingToggled

-

Methods Summary

- - - - - - - - - - - - - - - - - - -

requestDescription(game_name, mod_id, user_data)

Request description of a mod.

requestDownloadURL(game_name, mod_id, ...)

Request download URL for mod file.0

requestFileInfo(game_name, mod_id, file_id, ...)

requestFiles(game_name, mod_id, user_data)

Request the list of files belonging to a mod.

requestToggleEndorsement(game_name, mod_id, ...)

-

Attributes Documentation

-
-
-descriptionAvailable: pyqtSignal = Ellipsis
-
- -
-
-downloadURLsAvailable: pyqtSignal = Ellipsis
-
- -
-
-endorsementToggled: pyqtSignal = Ellipsis
-
- -
-
-endorsementsAvailable: pyqtSignal = Ellipsis
-
- -
-
-fileInfoAvailable: pyqtSignal = Ellipsis
-
- -
-
-filesAvailable: pyqtSignal = Ellipsis
-
- -
-
-requestFailed: pyqtSignal = Ellipsis
-
- -
-
-trackedModsAvailable: pyqtSignal = Ellipsis
-
- -
-
-trackingToggled: pyqtSignal = Ellipsis
-
- -

Methods Documentation

-
-
-requestDescription(game_name, mod_id, user_data)
-

Request description of a mod.

-
-
Return type:
-

None

-
-
Parameters:
-
    -

  • game_name – Name of the game containing the mod.

    • -

  • mod_id – Nexus ID of the mod.

    • -

  • user_data – User data to be returned with the result.

    • -
-
-
-
- -
-
-requestDownloadURL(game_name, mod_id, file_id, user_data)
-

Request download URL for mod file.0

-
-
Return type:
-

None

-
-
Parameters:
-
    -

  • game_name – Name of the game containing the mod.

    • -

  • mod_id – Nexus ID of the mod.

    • -

  • file_id – ID of the file for which a URL should be returned.

    • -

  • user_data – User data to be returned with the result.

    • -
-
-
-
- -
-
-requestFileInfo(game_name, mod_id, file_id, user_data)
-
-
Return type:
-

None

-
-
Parameters:
-
    -

  • game_name – Name of the game containing the mod.

    • -

  • mod_id – Nexus ID of the mod.

    • -

  • file_id – ID of the file for which information is requested.

    • -

  • user_data – User data to be returned with the result.

    • -
-
-
-
- -
-
-requestFiles(game_name, mod_id, user_data)
-

Request the list of files belonging to a mod.

-
-
Return type:
-

None

-
-
Parameters:
-
    -

  • game_name – Name of the game containing the mod.

    • -

  • mod_id – Nexus ID of the mod.

    • -

  • user_data – User data to be returned with the result.

    • -
-
-
-
- -
-
-requestToggleEndorsement(game_name, mod_id, mod_version, endorse, user_data)
-
-
Return type:
-

None

-
-
Parameters:
-
    -

  • game_name – Name of the game containing the mod.

    • -

  • mod_id – Nexus ID of the mod.

    • -

  • mod_version – Version of the mod.

    • -

  • endorse

    • -

  • user_data – User data to be returned with the result.

    • -
-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.IOrganizer.html b/api/mobase.IOrganizer.html deleted file mode 100644 index ea9dfd2..0000000 --- a/api/mobase.IOrganizer.html +++ /dev/null @@ -1,1266 +0,0 @@ - - - - - - - IOrganizer — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

IOrganizer

-
-
-class mobase.IOrganizer
-

Bases: object

-

Interface to class that provides information about the running session -of Mod Organizer to be used by plugins.

-

Methods Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

appVersion()

basePath()

createMod(name)

Create a new mod with the specified name.

createNexusBridge()

Create a new Nexus interface.

downloadManager()

downloadsPath()

findFileInfos(path, filter)

Find files in the virtual directory matching the specified filter.

findFiles(**kwds)

Helper for @overload to raise when called.

gameFeatures()

getFileOrigins(filename)

Retrieve the file origins for the specified file.

getGame(name)

Retrieve the game plugin matching the given name.

getPluginDataPath()

installMod(filename[, name_suggestion])

Install a mod archive at the specified location.

isPluginEnabled(**kwds)

Helper for @overload to raise when called.

listDirectories(directory)

Retrieve the list of (virtual) subdirectories in the given path.

managedGame()

modDataChanged(mod)

Notify the organizer that the given mod has changed.

modList()

modsPath()

onAboutToRun(**kwds)

Helper for @overload to raise when called.

onFinishedRun(callback)

Install a new handler to be called when an application has finished running.

onNextRefresh(callback[, immediate_if_possible])

Install a new handler to be called on the next refresh or immediately.

onPluginDisabled(**kwds)

Helper for @overload to raise when called.

onPluginEnabled(**kwds)

Helper for @overload to raise when called.

onPluginSettingChanged(callback)

Install a new handler to be called when a plugin setting is changed.

onProfileChanged(callback)

Install a new handler to be called when the current profile is changed.

onProfileCreated(callback)

Install a new handler to be called when a new profile is created.

onProfileRemoved(callback)

Install a new handler to be called when a profile is remove.

onProfileRenamed(callback)

Install a new handler to be called when a profile is renamed.

onUserInterfaceInitialized(callback)

Install a new handler to be called when the UI has been fully initialized.

overwritePath()

persistent(plugin_name, key[, default])

Retrieve the specified persistent value for a plugin.

pluginDataPath()

Retrieve the path to a directory where plugin data should be stored.

pluginList()

pluginSetting(plugin_name, key)

Retrieve settings of plugins.

profile()

profileName()

profilePath()

refresh([save_changes])

Refresh the internal mods file structure from disk.

resolvePath(filename)

Resolves a path relative to the virtual data directory to its absolute real path.

setPersistent(plugin_name, key, value[, sync])

Set the specified persistent value for a plugin.

setPluginSetting(plugin_name, key, value)

Set the specified setting for a plugin.

startApplication(executable[, args, cwd, ...])

Starts an application with virtual filesystem active.

virtualFileTree()

Retrieve a IFileTree object representing the virtual file tree.

waitForApplication(handle[, refresh])

Wait for the application corresponding to the given handle to finish.

-

Methods Documentation

-
-
-appVersion()
-
-
Return type:
-

VersionInfo

-
-
Returns:
-

The running version of Mod Organizer.

-
-
-
- -
-
-basePath()
-
-
Return type:
-

str

-
-
Returns:
-

The absolute path to the base directory of Mod Organizer.

-
-
-
- -
-
-createMod(name)
-

Create a new mod with the specified name.

-

If a mod with the same name already exists, the user will be queried. If the user chooses -to merge or replace, the call will succeed, otherwise the call will fail.

-
-
Return type:
-

IModInterface

-
-
Parameters:
-

name – Name of the mod to create.

-
-
Returns:
-

An interface to the newly created mod that can be used to modify it, or None if the mod

-
-
-

could not be created.

-
- -
-
-createNexusBridge()
-

Create a new Nexus interface.

-
-
Return type:
-

IModRepositoryBridge

-
-
Returns:
-

The newly created Nexus interface.

-
-
-
- -
-
-downloadManager()
-
-
Return type:
-

IDownloadManager

-
-
Returns:
-

The interface to the download manager.

-
-
-
- -
-
-downloadsPath()
-
-
Return type:
-

str

-
-
Returns:
-

The absolute path to the download directory.

-
-
-
- -
-
-findFileInfos(path, filter)
-

Find files in the virtual directory matching the specified filter.

-
-
Return type:
-

Sequence[FileInfo]

-
-
Parameters:
-
    -

  • path – The path to search in (relative to the ‘data’ folder).

    • -

  • filter – The function to use to filter files. Should return True for the files to keep.

    • -
-
-
Returns:
-

The list of QFileInfo corresponding to the matching files.

-
-
-
- -
-
-findFiles(**kwds)
-

Helper for @overload to raise when called.

-
- -
-
-gameFeatures()
-
-
Return type:
-

IGameFeatures

-
-
Returns:
-

The interface to the game features.

-
-
-
- -
-
-getFileOrigins(filename)
-

Retrieve the file origins for the specified file.

-

The origins are listed with their internal name. The internal name of a mod can differ -from the display name for disambiguation.

-
-
Return type:
-

Sequence[str]

-
-
Parameters:
-

filename – Path to the file to retrieve origins for (relative to the ‘data’ folder).

-
-
Returns:
-

The list of origins that contain the specified file, sorted by their priority.

-
-
-
- -
-
-getGame(name)
-

Retrieve the game plugin matching the given name.

-
-
Return type:
-

IPluginGame

-
-
Parameters:
-

name – Name of the game (short name).

-
-
Returns:
-

The plugin for the given game, or None if none was found.

-
-
-
- -
-
-static getPluginDataPath()
-
-
Return type:
-

str

-
-
Returns:
-

The directory for plugin data, typically plugins/data.

-
-
-
- -
-
-installMod(filename, name_suggestion='')
-

Install a mod archive at the specified location.

-
-
Return type:
-

IModInterface

-
-
Parameters:
-
    -

  • filename – Absolute filepath to the archive to install.

    • -

  • name_suggestion – Suggested name for this mod. This can still be changed by the user.

    • -
-
-
Returns:
-

An interface to the new installed mod, or None if no installation took place (canceled or failure).

-
-
-
- -
-
-isPluginEnabled(**kwds)
-

Helper for @overload to raise when called.

-
- -
-
-listDirectories(directory)
-

Retrieve the list of (virtual) subdirectories in the given path.

-
-
Return type:
-

Sequence[str]

-
-
Parameters:
-

directory – Path to the directory to list (relative to the ‘data’ folder).

-
-
Returns:
-

The list of directories in the given directory.

-
-
-
- -
-
-managedGame()
-
-
Return type:
-

IPluginGame

-
-
Returns:
-

The plugin corresponding to the current game.

-
-
-
- -
-
-modDataChanged(mod)
-

Notify the organizer that the given mod has changed.

-
-
Return type:
-

None

-
-
Parameters:
-

mod – The mod that has changed.

-
-
-
- -
-
-modList()
-
-
Return type:
-

IModList

-
-
Returns:
-

The interface to the mod list.

-
-
-
- -
-
-modsPath()
-
-
Return type:
-

str

-
-
Returns:
-

The (absolute) path to the mods directory.

-
-
-
- -
-
-onAboutToRun(**kwds)
-

Helper for @overload to raise when called.

-
- -
-
-onFinishedRun(callback)
-

Install a new handler to be called when an application has finished running.

-
-
Return type:
-

bool

-
-
Parameters:
-

callback – The function to call when an application has finished running. The first parameter is the absolute -path to the application, and the second parameter is the exit code of the application.

-
-
Returns:
-

True if the handler was installed properly (there are currently no reasons for

-
-
-

this to fail).

-
- -
-
-onNextRefresh(callback, immediate_if_possible=True)
-

Install a new handler to be called on the next refresh or immediately.

-
-
Return type:
-

bool

-
-
Parameters:
-
    -

  • callback – Function to call on the next refresh (or immediately).

    • -

  • immediate_if_possible – If True, immediately run the callback if no refresh is currently running.

    • -
-
-
Returns:
-

True if the handler was installed properly (there are currently no reasons for

-
-
-

this to fail).

-
- -
-
-onPluginDisabled(**kwds)
-

Helper for @overload to raise when called.

-
- -
-
-onPluginEnabled(**kwds)
-

Helper for @overload to raise when called.

-
- -
-
-onPluginSettingChanged(callback)
-

Install a new handler to be called when a plugin setting is changed.

-
-
Return type:
-

bool

-
-
Parameters:
-

callback – The function to call when a plugin setting is changed. The parameters are: The name of the plugin, the -name of the setting, the old value (or None if the setting did not exist before) and the new value -of the setting (or None if the setting has been removed).

-
-
Returns:
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
-
- -
-
-onProfileChanged(callback)
-

Install a new handler to be called when the current profile is changed.

-

The function is called when the profile is changed but some operations related to -the profile might not be finished when this is called (e.g., the virtual file system -might not be up-to-date).

-
-
Return type:
-

bool

-
-
Parameters:
-

callback – The function to call when the current profile is changed. The first parameter is the old profile (can -be None, e.g. at startup), and the second parameter is the new profile (cannot be None).

-
-
Returns:
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
-
- -
-
-onProfileCreated(callback)
-

Install a new handler to be called when a new profile is created.

-
-
Return type:
-

bool

-
-
Parameters:
-

callback – The function to call when a new profile is created. The parameter is the new profile (can be -a temporary object and should not be stored).

-
-
Returns:
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
-
- -
-
-onProfileRemoved(callback)
-

Install a new handler to be called when a profile is remove.

-

The callbacks are called after the profile has been removed so the profile is not accessible -anymore.

-
-
Return type:
-

bool

-
-
Parameters:
-

callback – The function to call when a profile is remove. The parameter is the name of the profile that was -removed.

-
-
Returns:
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
-
- -
-
-onProfileRenamed(callback)
-

Install a new handler to be called when a profile is renamed.

-
-
Return type:
-

bool

-
-
Parameters:
-

callback – The function to call when a profile is renamed. The first parameter is the profile being renamed, -the second parameter the previous name and the third parameter the new name.

-
-
Returns:
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
-
- -
-
-onUserInterfaceInitialized(callback)
-

Install a new handler to be called when the UI has been fully initialized.

-
-
Return type:
-

bool

-
-
Parameters:
-

callback – The function to call when the user-interface has been fully initialized. The parameter is the main -window of the application (QMainWindow).

-
-
Returns:
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
-
- -
-
-overwritePath()
-
-
Return type:
-

str

-
-
Returns:
-

The (absolute) path to the overwrite directory.

-
-
-
- -
-
-persistent(plugin_name, key, default=None)
-

Retrieve the specified persistent value for a plugin.

-

A persistent is an arbitrary value that the plugin can set and retrieve that is persistently stored -by the main application. There is no UI for the user to change this value but they can directly access -the storage

-
-
Return type:
-

None | bool | int | str | list[object] | dict[str, object]

-
-
Parameters:
-
    -

  • plugin_name – Name of the plugin for which to retrieve the value. This should always be IPlugin.name() unless you have a -really good reason to access data of another mod AND if you can verify that plugin is actually installed.

    • -

  • key – Identifier of the setting.

    • -

  • default – Default value to return if the key is not set (yet).

    • -
-
-
Returns:
-

The value corresponding to the given persistent setting, or def is the key is not found.

-
-
-
- -
-
-pluginDataPath()
-

Retrieve the path to a directory where plugin data should be stored.

-

For python plugins, it is recommended to use a dedicated folder (per plugin) if you need to -store data (resources, or multiple python files).

-
-
Return type:
-

str

-
-
Returns:
-

Path to a directory where plugin data should be stored.

-
-
-
- -
-
-pluginList()
-
-
Return type:
-

IPluginList

-
-
Returns:
-

The plugin list interface.

-
-
-
- -
-
-pluginSetting(plugin_name, key)
-

Retrieve settings of plugins.

-
-
Return type:
-

None | bool | int | str | list[object] | dict[str, object]

-
-
Parameters:
-
    -

  • plugin_name – Name of the plugin to retrieve the setting for.

    • -

  • key – Name of the setting to retrieve the value for.

    • -
-
-
Returns:
-

The value of the setting.

-
-
-
- -
-
-profile()
-
-
Return type:
-

IProfile

-
-
Returns:
-

The interface to the current profile.

-
-
-
- -
-
-profileName()
-
-
Return type:
-

str

-
-
Returns:
-

The name of the current profile, or an empty string if no profile has been loaded (yet).

-
-
-
- -
-
-profilePath()
-
-
Return type:
-

str

-
-
Returns:
-

The absolute path to the active profile or an empty string if no profile has been loaded (yet).

-
-
-
- -
-
-refresh(save_changes=True)
-

Refresh the internal mods file structure from disk. This includes the mod list, the plugin -list, data tab and other smaller things like problems button (same as pressing F5).

-

The main part of the refresh of the mods file structure, mod list and plugin list is done -asynchronously, so you should not expect them to be up-to-date when this function returns.

-
-
Return type:
-

None

-
-
Parameters:
-

save_changes – If True, the relevant profile information is saved first (enabled mods and order of mods).

-
-
-
- -
-
-resolvePath(filename)
-

Resolves a path relative to the virtual data directory to its absolute real path.

-
-
Return type:
-

str

-
-
Parameters:
-

filename – Path to resolve.

-
-
Returns:
-

The absolute real path, or an empty string if the path was not found.

-
-
-
- -
-
-setPersistent(plugin_name, key, value, sync=True)
-

Set the specified persistent value for a plugin.

-

This does not update the in-memory value for this setting, see setPluginSetting() for this.

-
-
Return type:
-

None

-
-
Parameters:
-
    -

  • plugin_name – Name of the plugin for which to change a value. This should always be IPlugin.name() unless you have a -really good reason to access data of another mod AND if you can verify that plugin is actually installed.

    • -

  • key – Identifier of the setting.

    • -

  • value – New value for the setting.

    • -

  • sync – If True, the storage is immediately written to disc. This costs performance but is safer against data loss.

    • -
-
-
-
- -
-
-setPluginSetting(plugin_name, key, value)
-

Set the specified setting for a plugin.

-

This automatically notify handlers register with onPluginSettingChanged, so you do not have to do it yourself.

-
-
Return type:
-

None

-
-
Parameters:
-
    -

  • plugin_name – Name of the plugin for which to change a value. This should always be IPlugin.name() unless you have a -really good reason to access data of another mod AND if you can verify that plugin is actually installed.

    • -

  • key – Identifier of the setting.

    • -

  • value – New value for the setting.

    • -
-
-
-
- -
-
-startApplication(executable, args=[], cwd='', profile='', forcedCustomOverwrite='', ignoreCustomOverwrite=False)
-

Starts an application with virtual filesystem active.

-
-
Return type:
-

int

-
-
Parameters:
-
    -

  • executable – Name or path of the executable. If this is only a filename, it will only work if it has been configured -in MO as an executable. If it is a relative path it is expected to be relative to the game directory.

    • -

  • args – Arguments to pass to the executable. If the list is empty, and executable refers to a configured executable, -the configured arguments are used.

    • -

  • cwd – The working directory for the executable. If this is empty, the path to the executable is used unless executable -referred to a configured MO executable, in which case the configured cwd is used.

    • -

  • profile – Profile to use. If this is empty (the default) the current profile is used.

    • -

  • forcedCustomOverwrite – The mod to set as the custom overwrite, regardless of what the profile has configured.

    • -

  • ignoreCustomOverwrite – Set to true to ignore the profile’s configured custom overwrite.

    • -
-
-
Returns:
-

The handle to the started application, or 0 if the application failed to start.

-
-
-
- -
-
-virtualFileTree()
-

Retrieve a IFileTree object representing the virtual file tree.

-
-
Return type:
-

IFileTree

-
-
Returns:
-

An IFileTree representing the virtual file tree.

-
-
-
- -
-
-waitForApplication(handle, refresh=True)
-

Wait for the application corresponding to the given handle to finish.

-

This will always show the lock overlay, regardless of whether the -user has disabled locking in the setting, so use this with care. -Note that the lock overlay will always allow the user to unlock, in -which case this will return False.

-
-
Return type:
-

tuple[bool, int]

-
-
Parameters:
-
    -

  • handle – Handle of the application to wait for (as returned by startApplication()).

    • -

  • refresh – Whether ModOrganizer should refresh after the process completed or not.

    • -
-
-
Returns:
-

A tuple (result, exitcode), where result is a boolean indicating if the application

-
-
-

completed successfully, and exitcode is the exit code of the application.

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.IPlugin.html b/api/mobase.IPlugin.html deleted file mode 100644 index 4a0f3bb..0000000 --- a/api/mobase.IPlugin.html +++ /dev/null @@ -1,612 +0,0 @@ - - - - - - - IPlugin — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

IPlugin

-
-
-class mobase.IPlugin
-

Bases: ABC

-

Base class for all plugins.

-

Methods Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

author()

description()

enabledByDefault()

Check whether this plugin should be enabled by default.

init(organizer)

Initialize this plugin.

localizedName()

Retrieve the localized name of the plugin.

master()

Retrieve the master plugin of this plugin.

name()

Retrieve the name of the plugin.

requirements()

Retrieve the requirements for this plugin.

settings()

version()

-

Methods Documentation

-
-
-abstract author()
-
-
Return type:
-

str

-
-
Returns:
-

The name of the plugin author.

-
-
-
- -
-
-abstract description()
-
-
Return type:
-

str

-
-
Returns:
-

The description for this plugin.

-
-
-
- -
-
-enabledByDefault()
-

Check whether this plugin should be enabled by default.

-
-
Return type:
-

bool

-
-
Returns:
-

True if this plugin should be enabled by default, False otherwise.

-
-
-
- -
-
-abstract init(organizer)
-

Initialize this plugin.

-

Note that this function may never be called if no IOrganizer is available -at that time, such as when creating the first instance in MO.

-

Plugins will probably want to store the organizer pointer. It is guaranteed -to be valid as long as the plugin is loaded.

-

These functions may be called before init(): -:rtype: bool

-
-
    -

  • name()

    • -

  • see IPluginGame for more.

    • -
-
-
-
Parameters:
-

organizer – The main organizer interface.

-
-
Returns:
-

True if the plugin was initialized correctly, False otherwise.

-
-
-
- -
-
-localizedName()
-

Retrieve the localized name of the plugin.

-

Unlike name(), this method can (and should!) return a localized name for the plugin. -This method returns name() by default.

-
-
Return type:
-

str

-
-
Returns:
-

The localized name of the plugin.

-
-
-
- -
-
-master()
-

Retrieve the master plugin of this plugin.

-

It is often easier to implement a functionality as multiple plugins in MO2, but ship the -plugins together, e.g. as a Python module or using createFunctions(). In this case, having -a master plugin (one of the plugin, or a separate one) tells MO2 that these plugins are -linked and should also be displayed together in the UI. If MO2 ever implements automatic -updates for plugins, the master() plugin will also be used for this purpose.

-
-
Return type:
-

str

-
-
Returns:
-

The master plugin of this plugin, or a null pointer if this plugin does not have a master.

-
-
-
- -
-
-abstract name()
-

Retrieve the name of the plugin.

-

The name of the plugin is used for internal storage purpose so it should not change, -and it should be static. In particular, you should not use a localized string (tr()) -for the plugin name.

-

In the future, we will provide a way to localized plugin names using a distinct method, -such as localizedName().

-
-
Return type:
-

str

-
-
Returns:
-

The name of the plugin.

-
-
-
- -
-
-requirements()
-

Retrieve the requirements for this plugin.

-

This method is called right after init() and the ownership the requirements is

-
-
Return type:
-

list[IPluginRequirement]

-
-
Returns:
-

The list of requirements for this plugin.

-
-
-
- -
-
-abstract settings()
-
-
Return type:
-

Sequence[PluginSetting]

-
-
Returns:
-

A list of settings for this plugin.

-
-
-
- -
-
-abstract version()
-
-
Return type:
-

VersionInfo

-
-
Returns:
-

The version of this plugin.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.IPluginDiagnose.html b/api/mobase.IPluginDiagnose.html deleted file mode 100644 index 1c9e690..0000000 --- a/api/mobase.IPluginDiagnose.html +++ /dev/null @@ -1,536 +0,0 @@ - - - - - - - IPluginDiagnose — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

IPluginDiagnose

-
-
-class mobase.IPluginDiagnose
-

Bases: IPlugin

-

Plugins that create problem reports to be displayed in the UI.

-

This can be used to report problems related to the same plugin (which implements further -interfaces) or as a stand-alone diagnosis tool.

-

Methods Summary

- - - - - - - - - - - - - - - - - - -

activeProblems()

Retrieve the list of active problems found by this plugin.

fullDescription(key)

Retrieve the full description of the problem corresponding to the given key.

hasGuidedFix(key)

Check if the problem corresponding to the given key has a guided fix.

shortDescription(key)

Retrieve the short description of the problem corresponding to the given key.

startGuidedFix(key)

Starts a guided fix for the problem corresponding to the given key.

-

Methods Documentation

-
-
-abstract activeProblems()
-

Retrieve the list of active problems found by this plugin.

-

This method returns a list of problem IDs, that are then used when calling other methods -such as shortDescription() or hasGuidedFix().

-
-
Return type:
-

list[int]

-
-
Returns:
-

The list of active problems for this plugin.

-
-
-
- -
-
-abstract fullDescription(key)
-

Retrieve the full description of the problem corresponding to the given key.

-
-
Return type:
-

str

-
-
Parameters:
-

key – ID of the problem.

-
-
Returns:
-

The full description of the problem.

-
-
Raises:
-

IndexError – If the key is not valid.

-
-
-
- -
-
-abstract hasGuidedFix(key)
-

Check if the problem corresponding to the given key has a guided fix.

-
-
Return type:
-

bool

-
-
Parameters:
-

key – ID of the problem.

-
-
Returns:
-

True if there is a guided fix for the problem, False otherwise.

-
-
Raises:
-

IndexError – If the key is not valid.

-
-
-
- -
-
-abstract shortDescription(key)
-

Retrieve the short description of the problem corresponding to the given key.

-
-
Return type:
-

str

-
-
Parameters:
-

key – ID of the problem.

-
-
Returns:
-

The short description of the problem.

-
-
Raises:
-

IndexError – If the key is not valid.

-
-
-
- -
-
-abstract startGuidedFix(key)
-

Starts a guided fix for the problem corresponding to the given key.

-

This method should throw ValueError if there is no guided fix for the corresponding -problem.

-
-
Return type:
-

None

-
-
Parameters:
-

key – ID of the problem.

-
-
Raises:
-
    -

  • IndexError – If the key is not valid.

    • -

  • ValueError – If there is no guided fix for this problem.

    • -
-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.IPluginFileMapper.html b/api/mobase.IPluginFileMapper.html deleted file mode 100644 index 3f51fe9..0000000 --- a/api/mobase.IPluginFileMapper.html +++ /dev/null @@ -1,437 +0,0 @@ - - - - - - - IPluginFileMapper — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

IPluginFileMapper

-
-
-class mobase.IPluginFileMapper
-

Bases: IPlugin

-

Plugins that adds virtual file links.

-

Methods Summary

- - - - - - -

mappings()

-

Methods Documentation

-
-
-abstract mappings()
-
-
Return type:
-

list[Mapping]

-
-
Returns:
-

Mapping for the virtual file system (VFS).

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.IPluginGame.html b/api/mobase.IPluginGame.html deleted file mode 100644 index 0a1bd3f..0000000 --- a/api/mobase.IPluginGame.html +++ /dev/null @@ -1,1080 +0,0 @@ - - - - - - - IPluginGame — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

IPluginGame

-
-
-class mobase.IPluginGame
-

Bases: IPlugin

-

Base classes for game plugins.

-

Each game requires a specific game plugin. These plugins were initially designed for -Bethesda games, so a lot of methods and attributes are irrelevant for other games. If -you wish to write a plugin for a much simpler game, please consider the basic_games -plugin: https://github.com/ModOrganizer2/modorganizer-basic_games

-

Methods Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

CCPlugins()

DLCPlugins()

binaryName()

dataDirectory()

detectGame()

Detect the game.

displayGameName()

documentsDirectory()

enabledPlugins()

executableForcedLoads()

executables()

gameDirectory()

gameIcon()

gameName()

gameNexusName()

gameShortName()

gameVariants()

Retrieve the list of variants for this game.

gameVersion()

getLauncherName()

getSupportURL()

iniFiles()

initializeProfile(directory, settings)

Initialize a profile for this game.

isInstalled()

listSaves(folder)

List saves in the given directory.

loadOrderMechanism()

looksValid(directory)

Check if the given directory looks like a valid game installation.

lootGameName()

nexusGameID()

Retrieve the Nexus game ID for this game.

nexusModOrganizerID()

Retrieve the Nexus mod ID of Mod Organizer for this game.

primaryPlugins()

primarySources()

Retrieve primary alternative 'short' names for this game.

savesDirectory()

secondaryDataDirectories()

Retrieve the list of secondary data directories.

setGamePath(path)

Set the path to the managed game.

setGameVariant(variant)

Set the game variant.

sortMechanism()

steamAPPId()

Retrieve the Steam app ID for this game.

validShortNames()

Retrieve the valid 'short' names for this game.

-

Methods Documentation

-
-
-CCPlugins()
-
-
Return type:
-

Sequence[str]

-
-
Returns:
-

The current list of active Creation Club plugins.

-
-
-
- -
-
-DLCPlugins()
-
-
Return type:
-

Sequence[str]

-
-
Returns:
-

The list of esp/esm files that are part of known DLCs.

-
-
-
- -
-
-abstract binaryName()
-
-
Return type:
-

str

-
-
Returns:
-

The name of the default executable to run (relative to the game folder).

-
-
-
- -
-
-abstract dataDirectory()
-
-
Return type:
-

QDir

-
-
Returns:
-

The path to the directory containing data (absolute path).

-
-
-
- -
-
-abstract detectGame()
-

Detect the game.

-

This method is the first called for game plugins (before init()). The following -methods should work properly after the call to detectGame() (and before init()): -:rtype: None

-
-
    -

  • gameName()

    • -

  • isInstalled()

    • -

  • gameIcon()

    • -

  • gameDirectory()

    • -

  • dataDirectory()

    • -

  • gameVariants()

    • -

  • looksValid()

    • -
-
-

See IPlugin.init() for more.

-
- -
-
-displayGameName()
-
-
Return type:
-

str

-
-
Returns:
-

The name of the game to user for display, default to gameName().

-
-
-
- -
-
-abstract documentsDirectory()
-
-
Return type:
-

QDir

-
-
Returns:
-

The directory of the documents folder where configuration files and such for this game reside.

-
-
-
- -
-
-enabledPlugins()
-
-
Return type:
-

Sequence[str]

-
-
Returns:
-

A list of plugins enabled by the game but not in a strict load order.

-
-
-
- -
-
-abstract executableForcedLoads()
-
-
Return type:
-

Sequence[ExecutableForcedLoadSetting]

-
-
Returns:
-

A list of automatically discovered libraries that can be force loaded with executables.

-
-
-
- -
-
-executables()
-
-
Return type:
-

Sequence[ExecutableInfo]

-
-
Returns:
-

A list of automatically discovered executables of the game itself and tools surrounding it.

-
-
-
- -
-
-abstract gameDirectory()
-
-
Return type:
-

QDir

-
-
Returns:
-

The directory containing the game installation.

-
-
-
- -
-
-abstract gameIcon()
-
-
Return type:
-

QIcon

-
-
Returns:
-

The icon representing the game.

-
-
-
- -
-
-abstract gameName()
-
-
Return type:
-

str

-
-
Returns:
-

The name of the game (for internal usage).

-
-
-
- -
-
-gameNexusName()
-
-
Return type:
-

str

-
-
Returns:
-

The name of the game identifier for Nexus.

-
-
-
- -
-
-abstract gameShortName()
-
-
Return type:
-

str

-
-
Returns:
-

The short name of the game.

-
-
-
- -
-
-gameVariants()
-

Retrieve the list of variants for this game.

-

If there are multiple variants of a game (and the variants make a difference to the -plugin), like a regular one and a GOTY-edition, the plugin can return a list of them -and the user gets to chose which one he owns.

-
-
Return type:
-

Sequence[str]

-
-
Returns:
-

The list of variants of the game.

-
-
-
- -
-
-abstract gameVersion()
-
-
Return type:
-

str

-
-
Returns:
-

The version of the game.

-
-
-
- -
-
-abstract getLauncherName()
-
-
Return type:
-

str

-
-
Returns:
-

The name of the launcher executable to run (relative to the game folder), or an

-
-
-

empty string if there is no launcher.

-
- -
-
-abstract getSupportURL()
-
-
Return type:
-

str

-
-
Returns:
-

An URL for the support page of this game.

-
-
-
- -
-
-iniFiles()
-
-
Return type:
-

Sequence[str]

-
-
Returns:
-

The list of INI files this game uses. The first file in the list should be the

-
-
-

‘main’ INI file.

-
- -
-
-abstract initializeProfile(directory, settings)
-

Initialize a profile for this game.

-

The MO app does not yet support virtualizing only specific aspects but plugins should be written -with this future functionality in mind.

-

This function will be used to initially create a profile, potentially to repair it or upgrade/downgrade -it so the implementations have to gracefully handle the case that the directory already contains files.

-
-
Return type:
-

None

-
-
Parameters:
-
    -

  • directory – The directory where the profile is to be initialized.

    • -

  • settings – The parameters for how the profile should be initialized.

    • -
-
-
-
- -
-
-abstract isInstalled()
-
-
Return type:
-

bool

-
-
Returns:
-

True if this game has been discovered as installed, False otherwise.

-
-
-
- -
-
-abstract listSaves(folder)
-

List saves in the given directory.

-
-
Return type:
-

list[ISaveGame]

-
-
Parameters:
-

folder – The folder to list saves from.

-
-
Returns:
-

The list of game saves in the given folder.

-
-
-
- -
-
-loadOrderMechanism()
-
-
Return type:
-

LoadOrderMechanism

-
-
Returns:
-

The load order mechanism used by this game.

-
-
-
- -
-
-abstract looksValid(directory)
-

Check if the given directory looks like a valid game installation.

-
-
Return type:
-

bool

-
-
Parameters:
-

directory – Directory to check.

-
-
Returns:
-

True if the directory looks like a valid installation of this game, False otherwise.

-
-
-
- -
-
-lootGameName()
-
-
Return type:
-

str

-
-
Returns:
-

The game name to use when calling LOOT from MO2, default to gameShortName().

-
-
-
- -
-
-abstract nexusGameID()
-

Retrieve the Nexus game ID for this game.

-

Example: For Skyrim, the Nexus game ID is 110.

-
-
Return type:
-

int

-
-
Returns:
-

The Nexus game ID for this game.

-
-
-
- -
-
-nexusModOrganizerID()
-

Retrieve the Nexus mod ID of Mod Organizer for this game.

-
-
Return type:
-

int

-
-
-
-
Example: For Skyrim SE, the mod ID of MO2 is 6194. You can find the mod ID in the URL:

https://www.nexusmods.com/skyrimspecialedition/mods/6194

-
-
-
-
Returns:
-

The Nexus mod ID of Mod Organizer for this game.

-
-
-
- -
-
-primaryPlugins()
-
-
Return type:
-

Sequence[str]

-
-
Returns:
-

The list of plugins that are part of the game and not considered optional.

-
-
-
- -
-
-primarySources()
-

Retrieve primary alternative ‘short’ names for this game.

-

This is used to determine if a Nexus (or other) download source should be considered -as a primary source for the game so that it is not flagged as an alternative one.

-
-
Return type:
-

Sequence[str]

-
-
Returns:
-

The list of primary alternative ‘short’ names for this game, or an empty list.

-
-
-
- -
-
-abstract savesDirectory()
-
-
Return type:
-

QDir

-
-
Returns:
-

The directory where save games are stored.

-
-
-
- -
-
-secondaryDataDirectories()
-

Retrieve the list of secondary data directories. Each directories should be -assigned a unique name that differs from “data” which is the name of the main -data directory returned by dataDirectory().

-
-
Return type:
-

Dict[str, QDir]

-
-
Returns:
-

A mapping from unique name to secondary data directories.

-
-
-
- -
-
-abstract setGamePath(path)
-

Set the path to the managed game.

-

This is called during instance creation if the game is not auto-detected and the user has -to specify the installation location. This is not called if the game has been auto-detected, -so isInstalled() should call this.

-
-
Return type:
-

None

-
-
Parameters:
-

path – Path to the game installation.

-
-
-
- -
-
-abstract setGameVariant(variant)
-

Set the game variant.

-

If there are multiple variants of game (as returned by gameVariants()), this will be -called on start with the user-selected game variant.

-
-
Return type:
-

None

-
-
Parameters:
-

variant – The game variant selected by the user.

-
-
-
- -
-
-sortMechanism()
-
-
Return type:
-

SortMechanism

-
-
Returns:
-

The sort mechanism for this game.

-
-
-
- -
-
-steamAPPId()
-

Retrieve the Steam app ID for this game.

-

If the game is not available on Steam, this should return an empty string.

-

If a game is available in multiple versions, those might have different app ids. The plugin -should try to return the right one

-
-
Return type:
-

str

-
-
Returns:
-

The Steam app ID for this game. Should be empty for games not available on steam.

-
-
-
- -
-
-abstract validShortNames()
-

Retrieve the valid ‘short’ names for this game.

-

This is used to determine if a Nexus download is valid for the current game since not all -game variants have their own nexus pages and others can handle downloads from other nexus -game pages and should be allowed to do so (e.g., you can install some Skyrim LE mod even -when using Skyrim SE).

-

The short name should be considered the primary handler for a directly supported game -for purposes of auto-launching an instance.

-
-
Return type:
-

Sequence[str]

-
-
Returns:
-

The list of valid short names for this game.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.IPluginInstaller.html b/api/mobase.IPluginInstaller.html deleted file mode 100644 index c37907f..0000000 --- a/api/mobase.IPluginInstaller.html +++ /dev/null @@ -1,573 +0,0 @@ - - - - - - - IPluginInstaller — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

IPluginInstaller

-
-
-class mobase.IPluginInstaller
-

Bases: IPlugin

-

This is the top-level class for installer. Actual installers should inherit either:

-
-
    -

  • IPluginInstallerSimple if the installer can work directly with the archive. This is what -most installers use.

    • -

  • IPluginInstallerCustom if the installer needs to perform custom operations. This is only -used by the external NCC installer and the OMOD installer.

    • -
-
-

Methods Summary

- - - - - - - - - - - - - - - - - - - - - - - - -

isArchiveSupported(tree)

Check if the given file tree corresponds to a supported archive for this installer.

isManualInstaller()

Check if this installer is a manual installer.

onInstallationEnd(result, new_mod)

Method calls at the end of the installation process.

onInstallationStart(archive, reinstallation, ...)

Method calls at the start of the installation process, before any other methods.

priority()

Retrieve the priority of this installer.

setInstallationManager(manager)

Set the installation manager for this installer.

setParentWidget(parent)

Set the parent widget for this installer.

-

Methods Documentation

-
-
-abstract isArchiveSupported(tree)
-

Check if the given file tree corresponds to a supported archive for this installer.

-
-
Return type:
-

bool

-
-
Parameters:
-

tree – The tree representing the content of the archive.

-
-
Returns:
-

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

-
-
-
- -
-
-abstract isManualInstaller()
-

Check if this installer is a manual installer.

-
-
Return type:
-

bool

-
-
Returns:
-

True if this installer is a manual installer, False otherwise.

-
-
-
- -
-
-onInstallationEnd(result, new_mod)
-

Method calls at the end of the installation process. This method is only called once -per installation process, even for recursive installations (e.g. with the bundle installer).

-
-
Return type:
-

None

-
-
Parameters:
-
    -

  • result – The result of the installation.

    • -

  • new_mod – If the installation succeeded (result is RESULT_SUCCESS), contains the newly -installed mod, otherwise it contains a null pointer.

    • -
-
-
-
- -
-
-onInstallationStart(archive, reinstallation, current_mod)
-

Method calls at the start of the installation process, before any other methods. -This method is only called once per installation process, even for recursive -installations (e.g. with the bundle installer).

-

If reinstallation is true, then the given mod is the mod being reinstalled (the one -selected by the user). If reinstallation is false and currentMod is not null, then -it corresponds to a mod MO2 thinks corresponds to the archive (e.g. based on matching Nexus ID -or name).

-

The default implementation does nothing.

-
-
Return type:
-

None

-
-
Parameters:
-
    -

  • archive – Path to the archive that is going to be installed.

    • -

  • reinstallation – True if this is a reinstallation, False otherwise.

    • -

  • current_mod – A currently installed mod corresponding to the archive being installed, or None -if there is no such mod.

    • -
-
-
-
- -
-
-abstract priority()
-

Retrieve the priority of this installer.

-

If multiple installers are able to handle an archive, the one with the highest priority wins.

-
-
Return type:
-

int

-
-
Returns:
-

The priority of this installer.

-
-
-
- -
-
-setInstallationManager(manager)
-

Set the installation manager for this installer.

-

Python plugins usually do not need to re-implement this and can directly access the installation -manager using _manager().

-
-
Return type:
-

None

-
-
Parameters:
-

manager – The installation manager.

-
-
-
- -
-
-setParentWidget(parent)
-

Set the parent widget for this installer.

-

Python plugins usually do not need to re-implement this and can directly access the parent -widget using _parentWidget() once the UI has been initialized.

-
-
Return type:
-

None

-
-
Parameters:
-

parent – The parent widget.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.IPluginInstallerCustom.html b/api/mobase.IPluginInstallerCustom.html deleted file mode 100644 index cb8bf40..0000000 --- a/api/mobase.IPluginInstallerCustom.html +++ /dev/null @@ -1,478 +0,0 @@ - - - - - - - IPluginInstallerCustom — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

IPluginInstallerCustom

-
-
-class mobase.IPluginInstallerCustom
-

Bases: 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(**kwds)

Helper for @overload to raise when called.

supportedExtensions()

-

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.

-
-
Return type:
-

InstallResult

-
-
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.

-
-
-
- -
-
-isArchiveSupported(**kwds)
-

Helper for @overload to raise when called.

-
- -
-
-abstract supportedExtensions()
-
-
Return type:
-

set[str]

-
-
Returns:
-

A list of file extensions that this installer can handle.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.IPluginInstallerSimple.html b/api/mobase.IPluginInstallerSimple.html deleted file mode 100644 index 4bc50fa..0000000 --- a/api/mobase.IPluginInstallerSimple.html +++ /dev/null @@ -1,457 +0,0 @@ - - - - - - - IPluginInstallerSimple — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

IPluginInstallerSimple

-
-
-class mobase.IPluginInstallerSimple
-

Bases: IPluginInstaller

-

Simple installer for mods. Simple installers only deal with an in-memory structure -representing the archive and can modify what to install and where by editing this structure. -Actually extracting the archive is handled by the manager.

-

Methods Summary

- - - - - - -

install(name, tree, version, nexus_id)

Install a mod from an archive filetree.

-

Methods Documentation

-
-
-abstract install(name, tree, version, nexus_id)
-

Install a mod from an archive filetree.

-

The installer can modify the given tree and use the manager to extract or create new -files.

-

This method returns different type of objects depending on the actual result of the -installation. The C++ bindings for this method always returns a tuple (result, tree, -version, id).

-
-
Return type:
-

Union[InstallResult, IFileTree, tuple[InstallResult, IFileTree, str, int]]

-
-
Parameters:
-
    -

  • 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).

    • -

  • tree – In-memory representation of the archive content.

    • -

  • version – Version of the mod, or an empty string is unknown.

    • -

  • nexus_id – ID of the mod, or -1 if unknown.

    • -
-
-
Returns:
-

In case of failure, the result of the installation, otherwise the modified tree or

-
-
-

a tuple (result, tree, version, id) containing the result of the installation, the -modified tree, the new version and the new ID. The tuple can be returned even if the -installation did not succeed.

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.IPluginList.html b/api/mobase.IPluginList.html deleted file mode 100644 index 9a717f3..0000000 --- a/api/mobase.IPluginList.html +++ /dev/null @@ -1,800 +0,0 @@ - - - - - - - IPluginList — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

IPluginList

-
-
-class mobase.IPluginList
-

Bases: object

-

Primary interface to the list of plugins.

-

Methods Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

hasLightExtension(name)

Determine if a plugin has a .esl extension.

hasMasterExtension(name)

Determine if a plugin has a .esm extension.

hasNoRecords(name)

Determine if a plugin has no records.

isLightFlagged(name)

Determine if a plugin is flagged as light.

isMasterFlagged(name)

Determine if a plugin is flagged as mater, i.e., a library, reference by other plugins.

isMediumFlagged(name)

Determine if a plugin is flagged as medium.

loadOrder(name)

Retrieve the load order of a plugin.

masters(name)

Retrieve the list of masters required for a plugin.

onPluginMoved(callback)

Install a new handler to be called when a plugin is moved.

onPluginStateChanged(callback)

Install a new handler to be called when plugin states change.

onRefreshed(callback)

Install a new handler to be called when the list of plugins is refreshed.

origin(name)

Retrieve the origin of a plugin.

pluginNames()

priority(name)

Retrieve the priority of a plugin.

setLoadOrder(loadorder)

Set the load order.

setPriority(name, priority)

Change the priority of a plugin.

setState(name, state)

Set the state of a plugin.

state(name)

Retrieve the state of a plugin.

-

Methods Documentation

-
-
-hasLightExtension(name)
-

Determine if a plugin has a .esl extension.

-
-
Return type:
-

bool

-
-
Parameters:
-

name – Filename of the plugin (without path but with file extension).

-
-
Returns:
-

True if the given file has a .esl extension, False otherwise or if the

-
-
-

file does not exist.

-
- -
-
-hasMasterExtension(name)
-

Determine if a plugin has a .esm extension.

-
-
Return type:
-

bool

-
-
Parameters:
-

name – Filename of the plugin (without path but with file extension).

-
-
Returns:
-

True if the given file has a .esm extension, False otherwise or if the

-
-
-

file does not exist.

-
- -
-
-hasNoRecords(name)
-

Determine if a plugin has no records.

-
-
Return type:
-

bool

-
-
Parameters:
-

name – Filename of the plugin (without path but with file extension).

-
-
Returns:
-

True if the given file plugin contains no records, False if it does OR if the

-
-
-

file does not exist.

-
- -
-
-isLightFlagged(name)
-

Determine if a plugin is flagged as light.

-

In gamebryo games, a master file will usually have a .esl file extension but -technically an esp can be flagged as light.

-
-
Return type:
-

bool

-
-
Parameters:
-

name – Filename of the plugin (without path but with file extension).

-
-
Returns:
-

True if the given plugin is a light plugin, False otherwise or if the

-
-
-

file does not exist.

-
- -
-
-isMasterFlagged(name)
-

Determine if a plugin is flagged as mater, i.e., a library, reference by -other plugins.

-

In gamebryo games, a master file will usually have a .esm file extension but -technically an esp can be flagged as master and an esm might not be.

-
-
Return type:
-

bool

-
-
Parameters:
-

name – Filename of the plugin (without path but with file extension).

-
-
Returns:
-

True if the given plugin is a master plugin, False otherwise or if the

-
-
-

file does not exist.

-
- -
-
-isMediumFlagged(name)
-

Determine if a plugin is flagged as medium.

-

This plugin flag was added in Starfield and signifies plugin records that -update existing records

-
-
Return type:
-

bool

-
-
Parameters:
-

name – Filename of the plugin (without path but with file extension).

-
-
Returns:
-

True if the given plugin is a medium plugin, False otherwise or if the

-
-
-

file does not exist.

-
- -
-
-loadOrder(name)
-

Retrieve the load order of a plugin.

-
-
Return type:
-

int

-
-
Parameters:
-

name – Filename of the plugin (without path but with file extension).

-
-
Returns:
-

The load order of the plugin (the order in which the game loads it). If all plugins are enabled this

-
-
-

is the same as the priority but disabled plugins will have a load order of -1. This also returns -1 -if the plugin does not exist.

-
- -
-
-masters(name)
-

Retrieve the list of masters required for a plugin.

-
-
Return type:
-

Sequence[str]

-
-
Parameters:
-

name – Filename of the plugin (without path but with file extension).

-
-
Returns:
-

The list of masters for the plugin (filenames with extension, no path).

-
-
-
- -
-
-onPluginMoved(callback)
-

Install a new handler to be called when a plugin is moved.

-
-
Return type:
-

bool

-
-
Parameters:
-

callback – The function to call when a plugin is moved. The first parameter is the plugin name, the -second the old priority of the plugin and the third one the new priority.

-
-
Returns:
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
-
- -
-
-onPluginStateChanged(callback)
-

Install a new handler to be called when plugin states change.

-
-
Return type:
-

bool

-
-
Parameters:
-

callback – The function to call when a plugin states change. The parameter is a map from plugin names to new -plugin states for the plugin whose states have changed.

-
-
Returns:
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
-
- -
-
-onRefreshed(callback)
-

Install a new handler to be called when the list of plugins is refreshed.

-
-
Return type:
-

bool

-
-
Parameters:
-

callback – The function to call when the list of plugins is refreshed.

-
-
Returns:
-

True if the handler was installed properly (there are currently no reasons for this to fail).

-
-
-
- -
-
-origin(name)
-

Retrieve the origin of a plugin. This is either the (internal) name of a mod, “overwrite” or “data”.

-

The internal name of a mod can differ from the display name for disambiguation.

-
-
Return type:
-

str

-
-
Parameters:
-

name – Filename of the plugin (without path but with file extension).

-
-
Returns:
-

The name of the origin of the plugin, or an empty string if the plugin does not exist.

-
-
-
- -
-
-pluginNames()
-
-
Return type:
-

Sequence[str]

-
-
Returns:
-

The list of all plugin names.

-
-
-
- -
-
-priority(name)
-

Retrieve the priority of a plugin.

-

The higher the priority, the more important.

-
-
Return type:
-

int

-
-
Parameters:
-

name – Filename of the plugin (without path but with file extension).

-
-
Returns:
-

The priority of the given plugin, or -1 if the plugin does not exist.

-
-
-
- -
-
-setLoadOrder(loadorder)
-

Set the load order.

-

Plugins not included in the list will be placed at highest priority in the order they -were before.

-
-
Return type:
-

None

-
-
Parameters:
-

loadorder – The new load order, specified by the list of plugin names, sorted.

-
-
-
- -
-
-setPriority(name, priority)
-

Change the priority of a plugin.

-
-
Return type:
-

bool

-
-
Parameters:
-
    -

  • name – Filename of the plugin (without path but with file extension).

    • -

  • priority – New priority of the plugin.

    • -
-
-
Returns:
-

True on success, False if the priority change was not possible. This is usually because

-
-
-

one of the parameters is invalid. The function returns true even if the plugin was not moved -at the specified priority (e.g. when trying to move a non-master plugin before a master one).

-
- -
-
-setState(name, state)
-

Set the state of a plugin.

-
-
Return type:
-

None

-
-
Parameters:
-
    -

  • name – Filename of the plugin (without path but with file extension).

    • -

  • state – New state of the plugin (INACTIVE or ACTIVE).

    • -
-
-
-
- -
-
-state(name)
-

Retrieve the state of a plugin.

-
-
Return type:
-

PluginState

-
-
Parameters:
-

name – Filename of the plugin (without path but with file extension).

-
-
Returns:
-

The state of the plugin.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.IPluginModPage.html b/api/mobase.IPluginModPage.html deleted file mode 100644 index 62c4ddc..0000000 --- a/api/mobase.IPluginModPage.html +++ /dev/null @@ -1,530 +0,0 @@ - - - - - - - IPluginModPage — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

IPluginModPage

-
-
-class mobase.IPluginModPage
-

Bases: IPlugin

-

Methods Summary

- - - - - - - - - - - - - - - - - - - - - -

displayName()

handlesDownload(page_url, download_url, fileinfo)

Check if the plugin handles the specified download.

icon()

pageURL()

setParentWidget(parent)

Set the parent widget for this mod page.

useIntegratedBrowser()

Indicates if the page should be displayed in the integrated browser.

-

Methods Documentation

-
-
-abstract displayName()
-
-
Return type:
-

str

-
-
Returns:
-

The name of the page as displayed in the UI.

-
-
-
- -
-
-abstract handlesDownload(page_url, download_url, fileinfo)
-

Check if the plugin handles the specified download.

-
-
Return type:
-

bool

-
-
Parameters:
-
    -

  • page_url – URL of the page that contains the download link.

    • -

  • download_url – The download URL.

    • -

  • fileinfo – Not usable in python.

    • -
-
-
Returns:
-

True if this plugin wants to handle the specified download, False otherwise.

-
-
-
- -
-
-abstract icon()
-
-
Return type:
-

QIcon

-
-
Returns:
-

The icon to display with the page.

-
-
-
- -
-
-abstract pageURL()
-
-
Return type:
-

QUrl

-
-
Returns:
-

The URL to open when the user wants to visit this mod page.

-
-
-
- -
-
-setParentWidget(parent)
-

Set the parent widget for this mod page.

-

Python plugins usually do not need to re-implement this and can directly access the parent -widget using _parentWidget() once the UI has been initialized.

-
-
Return type:
-

None

-
-
Parameters:
-

parent – The parent widget.

-
-
-
- -
-
-abstract useIntegratedBrowser()
-

Indicates if the page should be displayed in the integrated browser.

-

Unless the page provides a special means of starting downloads (like the nxm:// url schema -on nexus), it will not be possible to handle downloads unless the integrated browser is used!

-
-
Return type:
-

bool

-
-
Returns:
-

True if the page should be opened in the integrated browser, False otherwise.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.IPluginPreview.html b/api/mobase.IPluginPreview.html deleted file mode 100644 index bc92a78..0000000 --- a/api/mobase.IPluginPreview.html +++ /dev/null @@ -1,502 +0,0 @@ - - - - - - - IPluginPreview — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

IPluginPreview

-
-
-class mobase.IPluginPreview
-

Bases: IPlugin

-

These plugins add support for previewing files in the data pane. Right now all image formats supported -by qt are implemented (including dds) but no audio files and no 3d mesh formats.

-

Methods Summary

- - - - - - - - - - - - - - - -

genDataPreview(file_data, filename, max_size)

Generate a preview widget from in-memory data.

genFilePreview(filename, max_size)

Generate a preview widget for the specified file.

supportedExtensions()

supportsArchives()

Check if this preview plugin supports preview from in-memory data.

-

Methods Documentation

-
-
-abstract genDataPreview(file_data, filename, max_size)
-

Generate a preview widget from in-memory data.

-
-
Return type:
-

QWidget

-
-
Parameters:
-
    -

  • file_data – In-memory data to preview.

    • -

  • filename – Name of the file the data comes from.

    • -

  • max_size – Maximum size of the generated widget.

    • -
-
-
Returns:
-

The widget showing a preview of the in-memory data.

-
-
-
- -
-
-abstract genFilePreview(filename, max_size)
-

Generate a preview widget for the specified file.

-
-
Return type:
-

QWidget

-
-
Parameters:
-
    -

  • filename – Path to the file to preview.

    • -

  • max_size – Maximum size of the generated widget.

    • -
-
-
Returns:
-

The widget showing a preview of the file.

-
-
-
- -
-
-abstract supportedExtensions()
-
-
Return type:
-

set[str]

-
-
Returns:
-

The list of file extensions that are supported by this preview plugin.

-
-
-
- -
-
-abstract supportsArchives()
-

Check if this preview plugin supports preview from in-memory data.

-
-
Return type:
-

bool

-
-
Returns:
-

True if the plugin supports preview from raw data, False otherwise.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.IPluginRequirement.html b/api/mobase.IPluginRequirement.html deleted file mode 100644 index f4126a4..0000000 --- a/api/mobase.IPluginRequirement.html +++ /dev/null @@ -1,441 +0,0 @@ - - - - - - - IPluginRequirement — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

IPluginRequirement

-
-
-class mobase.IPluginRequirement
-

Bases: object

-

Class representing requirements for plugins.

-

Methods Summary

- - - - - - -

check(organizer)

Check if the requirement is met, and return a problem if not.

-

Methods Documentation

-
-
-check(organizer)
-

Check if the requirement is met, and return a problem if not.

-
-
Return type:
-

Optional[Problem]

-
-
Parameters:
-

organizer – The IOrganizer instance.

-
-
Returns:
-

The problem found if the requirement is not met, otherwise None.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.IPluginTool.html b/api/mobase.IPluginTool.html deleted file mode 100644 index 5fa964a..0000000 --- a/api/mobase.IPluginTool.html +++ /dev/null @@ -1,507 +0,0 @@ - - - - - - - IPluginTool — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

IPluginTool

-
-
-class mobase.IPluginTool
-

Bases: IPlugin

-

This is the simplest of plugin interfaces. Such plugins simply place an icon inside the tools sub-menu -and get invoked when the user clicks it. They are expected to have a user interface of some sort. These -are almost like independent applications except they can access all Mod Organizer interfaces like querying -and modifying the current profile, mod list, load order, use MO to install mods and so on. A tool plugin -can (and should!) integrate its UI as a window inside MO and thus doesn’t have to initialize a windows -application itself.

-

Methods Summary

- - - - - - - - - - - - - - - - - - -

display()

Called when the user starts the tool.

displayName()

icon()

setParentWidget(parent)

Set the parent widget for this tool.

tooltip()

-

Methods Documentation

-
-
-abstract display()
-

Called when the user starts the tool.

-
-
Return type:
-

None

-
-
-
- -
-
-abstract displayName()
-
-
Return type:
-

str

-
-
Returns:
-

The display name for this tool, as shown in the tool menu.

-
-
-
- -
-
-abstract icon()
-
-
Return type:
-

QIcon

-
-
Returns:
-

The icon for this tool, or a default-constructed QICon().

-
-
-
- -
-
-setParentWidget(parent)
-

Set the parent widget for this tool.

-

Python plugins usually do not need to re-implement this and can directly access the parent -widget using _parentWidget() once the UI has been initialized.

-
-
Return type:
-

None

-
-
Parameters:
-

parent – The parent widget.

-
-
-
- -
-
-abstract tooltip()
-
-
Return type:
-

str

-
-
Returns:
-

The tooltip for this tool.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.IProfile.html b/api/mobase.IProfile.html deleted file mode 100644 index 6dbc24f..0000000 --- a/api/mobase.IProfile.html +++ /dev/null @@ -1,526 +0,0 @@ - - - - - - - IProfile — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

IProfile

-
-
-class mobase.IProfile
-

Bases: object

-

Interface to interact with Mod Organizer 2 profiles.

-

Methods Summary

- - - - - - - - - - - - - - - - - - - - - -

absoluteIniFilePath(inifile)

Retrieve the absolute file path to the corresponding INI file for this profile.

absolutePath()

invalidationActive()

localSavesEnabled()

localSettingsEnabled()

name()

-

Methods Documentation

-
-
-absoluteIniFilePath(inifile)
-

Retrieve the absolute file path to the corresponding INI file for this profile.

-

If iniFile does not correspond to a file in the list of INI files for the -current game (as returned by IPluginGame::iniFiles), the path to the global -file will be returned (if iniFile is absolute, iniFile is returned, otherwise -the path is assumed relative to the game documents directory).

-
-
Return type:
-

str

-
-
Parameters:
-

inifile – INI file to retrieve a path for. This can either be the name of a file or a path to the -absolute file outside of the profile.

-
-
Returns:
-

The absolute path for the given INI file for this profile.

-
-
-
- -
-
-absolutePath()
-
-
Return type:
-

str

-
-
Returns:
-

The absolute path to the profile folder.

-
-
-
- -
-
-invalidationActive()
-
-
Return type:
-

tuple[bool, bool]

-
-
Returns:
-

True if automatic archive invalidation is enabled for this profile, False otherwise.

-
-
-
- -
-
-localSavesEnabled()
-
-
Return type:
-

bool

-
-
Returns:
-

True if profile-specific saves are enabled for this profile, False otherwise.

-
-
-
- -
-
-localSettingsEnabled()
-
-
Return type:
-

bool

-
-
Returns:
-

True if profile-specific game settings are enabled for this profile, False otherwise.

-
-
-
- -
-
-name()
-
-
Return type:
-

str

-
-
Returns:
-

The name of this profile.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.ISaveGame.html b/api/mobase.ISaveGame.html deleted file mode 100644 index c4cb9a4..0000000 --- a/api/mobase.ISaveGame.html +++ /dev/null @@ -1,507 +0,0 @@ - - - - - - - ISaveGame — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

ISaveGame

-
-
-class mobase.ISaveGame
-

Bases: object

-

Base class for information about what is in a save game.

-

Methods Summary

- - - - - - - - - - - - - - - - - - -

allFiles()

getCreationTime()

Retrieve the creation time of the save.

getFilepath()

getName()

getSaveGroupIdentifier()

Retrieve the name of the group this files belong to.

-

Methods Documentation

-
-
-allFiles()
-
-
Return type:
-

Sequence[Union[str, PathLike[str], QFileInfo]]

-
-
Returns:
-

The list of all files related to this save.

-
-
-
- -
-
-getCreationTime()
-

Retrieve the creation time of the save.

-

The creation time of a save is not always the same as the creation time of -the file containing the save.

-
-
Return type:
-

QDateTime

-
-
Returns:
-

The creation time of the save.

-
-
-
- -
-
-getFilepath()
-
-
Return type:
-

Union[str, PathLike[str], QFileInfo]

-
-
Returns:
-

The path name to the (main) file or folder for the save.

-
-
-
- -
-
-getName()
-
-
Return type:
-

str

-
-
Returns:
-

The name of this save, for display purpose.

-
-
-
- -
-
-getSaveGroupIdentifier()
-

Retrieve the name of the group this files belong to.

-

The name can be used to identify sets of saves to transfer between profiles. For -RPG games, this is usually the name of a character.

-
-
Return type:
-

str

-
-
Returns:
-

The group identifier for this save game.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.ISaveGameInfoWidget.html b/api/mobase.ISaveGameInfoWidget.html deleted file mode 100644 index 7e19fae..0000000 --- a/api/mobase.ISaveGameInfoWidget.html +++ /dev/null @@ -1,438 +0,0 @@ - - - - - - - ISaveGameInfoWidget — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

ISaveGameInfoWidget

-
-
-class mobase.ISaveGameInfoWidget(parent=None)
-

Bases: QWidget

-

Base class for a save game info widget.

-

Methods Summary

- - - - - - -

setSave(save)

Set the save file to display in this widget.

-

Methods Documentation

-
-
-abstract setSave(save)
-

Set the save file to display in this widget.

-
-
Return type:
-

None

-
-
Parameters:
-

save – The save to display in the widget

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.InstallResult.html b/api/mobase.InstallResult.html deleted file mode 100644 index c094240..0000000 --- a/api/mobase.InstallResult.html +++ /dev/null @@ -1,476 +0,0 @@ - - - - - - - InstallResult — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

InstallResult

-
-
-class mobase.InstallResult(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
-

Bases: Enum

-

Attributes Summary

- - - - - - - - - - - - - - - - - - - - - - - - -

CANCELED

FAILED

MANUAL_REQUESTED

NOT_ATTEMPTED

SUCCESS

name

value

-

Attributes Documentation

-
-
-CANCELED = None
-
- -
-
-FAILED = None
-
- -
-
-MANUAL_REQUESTED = None
-
- -
-
-NOT_ATTEMPTED = None
-
- -
-
-SUCCESS = None
-
- -
-
-name
-
- -
-
-value
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.LoadOrderMechanism.html b/api/mobase.LoadOrderMechanism.html deleted file mode 100644 index f1cfce7..0000000 --- a/api/mobase.LoadOrderMechanism.html +++ /dev/null @@ -1,460 +0,0 @@ - - - - - - - LoadOrderMechanism — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

LoadOrderMechanism

-
-
-class mobase.LoadOrderMechanism(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
-

Bases: Enum

-

Attributes Summary

- - - - - - - - - - - - - - - - - - -

FILE_TIME

NONE

PLUGINS_TXT

name

value

-

Attributes Documentation

-
-
-FILE_TIME = None
-
- -
-
-NONE = None
-
- -
-
-PLUGINS_TXT = None
-
- -
-
-name
-
- -
-
-value
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.LocalSavegames.html b/api/mobase.LocalSavegames.html deleted file mode 100644 index 90c16b4..0000000 --- a/api/mobase.LocalSavegames.html +++ /dev/null @@ -1,446 +0,0 @@ - - - - - - - LocalSavegames — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

LocalSavegames

-
-
-class mobase.LocalSavegames
-

Bases: GameFeature

-

Methods Summary

- - - - - - - - - -

mappings(profile_save_dir)

prepareProfile(profile)

-

Methods Documentation

-
-
-abstract mappings(profile_save_dir)
-
-
Return type:
-

list[Mapping]

-
-
-
- -
-
-abstract prepareProfile(profile)
-
-
Return type:
-

bool

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.Mapping.html b/api/mobase.Mapping.html deleted file mode 100644 index 6308480..0000000 --- a/api/mobase.Mapping.html +++ /dev/null @@ -1,454 +0,0 @@ - - - - - - - Mapping — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Mapping

-
-
-class mobase.Mapping
-
-class mobase.Mapping(source: str, destination: str, is_directory: bool, create_target: bool = False)
-

Bases: object

-

Attributes Summary

- - - - - - - - - - - - - - - -

createTarget

destination

isDirectory

source

-

Attributes Documentation

-
-
-createTarget
-
- -
-
-destination
-
- -
-
-isDirectory
-
- -
-
-source
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.ModDataChecker.html b/api/mobase.ModDataChecker.html deleted file mode 100644 index 3ab5c0a..0000000 --- a/api/mobase.ModDataChecker.html +++ /dev/null @@ -1,502 +0,0 @@ - - - - - - - ModDataChecker — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

ModDataChecker

-
-
-class mobase.ModDataChecker
-

Bases: GameFeature

-

Game feature that is used to check the content of a data tree.

-

Attributes Summary

- - - - - - - - - - - - -

FIXABLE

INVALID

VALID

-

Methods Summary

- - - - - - - - - -

dataLooksValid(filetree)

Check that the given filetree represent a valid mod layout, or can be easily fixed.

fix(filetree)

Try to fix the given tree.

-

Attributes Documentation

-
-
-FIXABLE: CheckReturn = Ellipsis
-
- -
-
-INVALID: CheckReturn = Ellipsis
-
- -
-
-VALID: CheckReturn = Ellipsis
-
- -

Methods Documentation

-
-
-abstract dataLooksValid(filetree)
-

Check that the given filetree represent a valid mod layout, or can be easily -fixed.

-

This method is mainly used during installation (to find which installer should -be used or to recurse into multi-level archives), or to quickly indicates to a -user if a mod looks valid.

-

This method does not have to be exact, it only has to indicate if the given tree -looks like a valid mod or not by quickly checking the structure (heavy operations -should be avoided).

-

If the tree can be fixed by the fix() method, this method should return FIXABLE. -FIXABLE should only be returned when it is guaranteed that fix() can fix the tree.

-
-
Return type:
-

CheckReturn

-
-
Parameters:
-

filetree – The tree starting at the root of the “data” folder.

-
-
Returns:
-

Whether the tree is invalid, fixable or valid.

-
-
-
- -
-
-fix(filetree)
-

Try to fix the given tree.

-

This method is used during installation to try to fix invalid archives and will only be -called if dataLooksValid returned FIXABLE.

-
-
Return type:
-

IFileTree | None

-
-
Parameters:
-

filetree – The tree to try to fix. Can be modified during the process.

-
-
Returns:
-

The fixed tree, or a null pointer if the tree could not be fixed.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.ModDataContent.html b/api/mobase.ModDataContent.html deleted file mode 100644 index 9714af8..0000000 --- a/api/mobase.ModDataContent.html +++ /dev/null @@ -1,487 +0,0 @@ - - - - - - - ModDataContent — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

ModDataContent

-
-
-class mobase.ModDataContent
-

Bases: GameFeature

-

The ModDataContent feature is used (when available) to indicate to users the content -of mods in the “Content” column.

-

The feature exposes a list of possible content types, each associated with an ID, a name -and an icon. The icon is the path to either:

-
-
    -

  • A Qt resource or;

    • -

  • A file on the disk.

    • -
-
-

In order to facilitate the implementation, MO2 already provides a set of icons that can -be used. Those icons are all under :/MO/gui/content (e.g. :/MO/gui/content/plugin or :/MO/gui/content/music `).

-

The list of available icons is:

-
-
    -

  • plugin: plugin-icon

    • -

  • skyproc: skyproc-icon

    • -

  • texture: texture-icon

    • -

  • music: music-icon

    • -

  • sound: sound-icon

    • -

  • interface: interface-icon

    • -

  • skse: skse-icon

    • -

  • script: script-icon

    • -

  • mesh: mesh-icon

    • -

  • string: string-icon

    • -

  • bsa: bsa-icon

    • -

  • menu: menu-icon

    • -

  • inifile: inifile-icon

    • -

  • modgroup: modgroup-icon

    • -
-
-

Methods Summary

- - - - - - - - - -

getAllContents()

getContentsFor(filetree)

Retrieve the list of contents in the given tree.

-

Methods Documentation

-
-
-abstract getAllContents()
-
-
Return type:
-

list[Content]

-
-
Returns:
-

The list of all possible contents for the corresponding game.

-
-
-
- -
-
-abstract getContentsFor(filetree)
-

Retrieve the list of contents in the given tree.

-
-
Return type:
-

list[int]

-
-
Parameters:
-

filetree – The tree corresponding to the mod to retrieve contents for.

-
-
Returns:
-

The IDs of the content in the given tree.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.ModRepositoryFileInfo.html b/api/mobase.ModRepositoryFileInfo.html deleted file mode 100644 index b92e732..0000000 --- a/api/mobase.ModRepositoryFileInfo.html +++ /dev/null @@ -1,569 +0,0 @@ - - - - - - - ModRepositoryFileInfo — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

ModRepositoryFileInfo

-
-
-class mobase.ModRepositoryFileInfo(other: ModRepositoryFileInfo)
-
-class mobase.ModRepositoryFileInfo(game_name: str = '', mod_id: int = 0, file_id: int = 0)
-

Bases: object

-

Attributes Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

categoryID

description

fileCategory

fileID

fileName

fileSize

fileTime

gameName

modID

modName

name

newestVersion

repository

uri

userData

version

-

Methods Summary

- - - - - - -

createFromJson(data)

-

Attributes Documentation

-
-
-categoryID
-
- -
-
-description
-
- -
-
-fileCategory
-
- -
-
-fileID
-
- -
-
-fileName
-
- -
-
-fileSize
-
- -
-
-fileTime
-
- -
-
-gameName
-
- -
-
-modID
-
- -
-
-modName
-
- -
-
-name
-
- -
-
-newestVersion
-
- -
-
-repository
-
- -
-
-uri
-
- -
-
-userData
-
- -
-
-version
-
- -

Methods Documentation

-
-
-static createFromJson(data)
-
-
Return type:
-

ModRepositoryFileInfo

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.ModState.html b/api/mobase.ModState.html deleted file mode 100644 index 750ff9a..0000000 --- a/api/mobase.ModState.html +++ /dev/null @@ -1,492 +0,0 @@ - - - - - - - ModState — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

ModState

-
-
-class mobase.ModState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
-

Bases: Enum

-

Attributes Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

ACTIVE

ALTERNATE

EMPTY

ENDORSED

ESSENTIAL

EXISTS

VALID

name

value

-

Attributes Documentation

-
-
-ACTIVE = None
-
- -
-
-ALTERNATE = None
-
- -
-
-EMPTY = None
-
- -
-
-ENDORSED = None
-
- -
-
-ESSENTIAL = None
-
- -
-
-EXISTS = None
-
- -
-
-VALID = None
-
- -
-
-name
-
- -
-
-value
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.PluginRequirementFactory.html b/api/mobase.PluginRequirementFactory.html deleted file mode 100644 index 7a999ea..0000000 --- a/api/mobase.PluginRequirementFactory.html +++ /dev/null @@ -1,485 +0,0 @@ - - - - - - - PluginRequirementFactory — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

PluginRequirementFactory

-
-
-class mobase.PluginRequirementFactory
-

Bases: object

-

Methods Summary

- - - - - - - - - - - - - - - -

basic(checker, description)

Create a basic requirement.

diagnose(diagnose)

Construct a requirement from a diagnose plugin.

gameDependency(**kwds)

Helper for @overload to raise when called.

pluginDependency(**kwds)

Helper for @overload to raise when called.

-

Methods Documentation

-
-
-static basic(checker, description)
-

Create a basic requirement.

-
-
Return type:
-

IPluginRequirement

-
-
Parameters:
-
    -

  • checker – The callable to use to check if the requirement is met. Should return True -if the requirement is met, False otherwise.

    • -

  • description – The description of the problem, when the requirement is not met.

    • -
-
-
Returns:
-

The constructed requirement.

-
-
-
- -
-
-static diagnose(diagnose)
-

Construct a requirement from a diagnose plugin.

-

If the wrapped diagnose plugin reports a problem, the requirement fails -and the associated message is the one from the diagnose plugin (or the -list of messages if multiple problems were reported).

-
-
Return type:
-

IPluginRequirement

-
-
Parameters:
-

diagnose – The diagnose plugin to wrap in this requirement.

-
-
Returns:
-

The constructed requirement.

-
-
-
- -
-
-gameDependency(**kwds)
-

Helper for @overload to raise when called.

-
- -
-
-pluginDependency(**kwds)
-

Helper for @overload to raise when called.

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.PluginSetting.html b/api/mobase.PluginSetting.html deleted file mode 100644 index 24e4acd..0000000 --- a/api/mobase.PluginSetting.html +++ /dev/null @@ -1,446 +0,0 @@ - - - - - - - PluginSetting — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

PluginSetting

-
-
-class mobase.PluginSetting(key, description, default_value)
-

Bases: object

-

Class to hold the user-configurable parameters a plugin accepts. The purpose of this class is -only to inform the application what settings to offer to the user, it does not hold the actual value.

-

Attributes Summary

- - - - - - - - - - - - -

default_value

description

key

-

Attributes Documentation

-
-
-default_value
-
- -
-
-description
-
- -
-
-key
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.PluginState.html b/api/mobase.PluginState.html deleted file mode 100644 index 9941a12..0000000 --- a/api/mobase.PluginState.html +++ /dev/null @@ -1,460 +0,0 @@ - - - - - - - PluginState — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

PluginState

-
-
-class mobase.PluginState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
-

Bases: Enum

-

Attributes Summary

- - - - - - - - - - - - - - - - - - -

ACTIVE

INACTIVE

MISSING

name

value

-

Attributes Documentation

-
-
-ACTIVE = None
-
- -
-
-INACTIVE = None
-
- -
-
-MISSING = None
-
- -
-
-name
-
- -
-
-value
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.ProfileSetting.html b/api/mobase.ProfileSetting.html deleted file mode 100644 index 5b66a05..0000000 --- a/api/mobase.ProfileSetting.html +++ /dev/null @@ -1,468 +0,0 @@ - - - - - - - ProfileSetting — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

ProfileSetting

-
-
-class mobase.ProfileSetting(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
-

Bases: Enum

-

Attributes Summary

- - - - - - - - - - - - - - - - - - - - - -

CONFIGURATION

MODS

PREFER_DEFAULTS

SAVEGAMES

name

value

-

Attributes Documentation

-
-
-CONFIGURATION = None
-
- -
-
-MODS = None
-
- -
-
-PREFER_DEFAULTS = None
-
- -
-
-SAVEGAMES = None
-
- -
-
-name
-
- -
-
-value
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.ReleaseType.html b/api/mobase.ReleaseType.html deleted file mode 100644 index 1d4f52d..0000000 --- a/api/mobase.ReleaseType.html +++ /dev/null @@ -1,476 +0,0 @@ - - - - - - - ReleaseType — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

ReleaseType

-
-
-class mobase.ReleaseType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
-

Bases: Enum

-

Attributes Summary

- - - - - - - - - - - - - - - - - - - - - - - - -

ALPHA

BETA

CANDIDATE

FINAL

PRE_ALPHA

name

value

-

Attributes Documentation

-
-
-ALPHA = None
-
- -
-
-BETA = None
-
- -
-
-CANDIDATE = None
-
- -
-
-FINAL = None
-
- -
-
-PRE_ALPHA = None
-
- -
-
-name
-
- -
-
-value
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.SaveGameInfo.html b/api/mobase.SaveGameInfo.html deleted file mode 100644 index ab65b36..0000000 --- a/api/mobase.SaveGameInfo.html +++ /dev/null @@ -1,462 +0,0 @@ - - - - - - - SaveGameInfo — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

SaveGameInfo

-
-
-class mobase.SaveGameInfo
-

Bases: GameFeature

-

Feature to get hold of stuff to do with save games.

-

Methods Summary

- - - - - - - - - -

getMissingAssets(save)

Retrieve missing assets from the save.

getSaveGameWidget(parent)

Retrieve a widget to display over the save game list.

-

Methods Documentation

-
-
-abstract getMissingAssets(save)
-

Retrieve missing assets from the save.

-
-
Return type:
-

Dict[str, Sequence[str]]

-
-
Parameters:
-

save – The save to find missing assets for.

-
-
Returns:
-

A collection of missing assets and the modules that can supply those assets.

-
-
-
- -
-
-abstract getSaveGameWidget(parent)
-

Retrieve a widget to display over the save game list.

-

This method is allowed to return None in case no widget has been implemented.

-
-
Return type:
-

ISaveGameInfoWidget | None

-
-
Parameters:
-

parent – The parent widget.

-
-
Returns:
-

A SaveGameInfoWidget to display information about save game.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.ScriptExtender.html b/api/mobase.ScriptExtender.html deleted file mode 100644 index c52f07f..0000000 --- a/api/mobase.ScriptExtender.html +++ /dev/null @@ -1,549 +0,0 @@ - - - - - - - ScriptExtender — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

ScriptExtender

-
-
-class mobase.ScriptExtender
-

Bases: GameFeature

-

Methods Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - -

binaryName()

getArch()

getExtenderVersion()

isInstalled()

loaderName()

loaderPath()

pluginPath()

savegameExtension()

Retrieve the extension of script extender save files.

-

Methods Documentation

-
-
-abstract binaryName()
-
-
Return type:
-

str

-
-
Returns:
-

The name of the script extender binary.

-
-
-
- -
-
-abstract getArch()
-
-
Return type:
-

int

-
-
Returns:
-

The CPU platform of the extender.

-
-
-
- -
-
-abstract getExtenderVersion()
-
-
Return type:
-

str

-
-
Returns:
-

The version of the script extender.

-
-
-
- -
-
-abstract isInstalled()
-
-
Return type:
-

bool

-
-
Returns:
-

True if the script extender is installed, False otherwise.

-
-
-
- -
-
-abstract loaderName()
-
-
Return type:
-

str

-
-
Returns:
-

The loader to use to ensure the game runs with the script extender.

-
-
-
- -
-
-abstract loaderPath()
-
-
Return type:
-

Union[str, PathLike[str], QFileInfo]

-
-
Returns:
-

The full path to the script extender loader.

-
-
-
- -
-
-abstract pluginPath()
-
-
Return type:
-

Union[str, PathLike[str], QDir]

-
-
Returns:
-

The script extender plugin path, relative to the data folder.

-
-
-
- -
-
-abstract savegameExtension()
-

Retrieve the extension of script extender save files.

-
-
Return type:
-

str

-
-
Returns:
-

The extension of script extender save files (e.g. “skse”).

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.SortMechanism.html b/api/mobase.SortMechanism.html deleted file mode 100644 index 25be683..0000000 --- a/api/mobase.SortMechanism.html +++ /dev/null @@ -1,468 +0,0 @@ - - - - - - - SortMechanism — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

SortMechanism

-
-
-class mobase.SortMechanism(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
-

Bases: Enum

-

Attributes Summary

- - - - - - - - - - - - - - - - - - - - - -

BOSS

LOOT

MLOX

NONE

name

value

-

Attributes Documentation

-
-
-BOSS = None
-
- -
-
-LOOT = None
-
- -
-
-MLOX = None
-
- -
-
-NONE = None
-
- -
-
-name
-
- -
-
-value
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.TrackedState.html b/api/mobase.TrackedState.html deleted file mode 100644 index 754c1d2..0000000 --- a/api/mobase.TrackedState.html +++ /dev/null @@ -1,460 +0,0 @@ - - - - - - - TrackedState — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

TrackedState

-
-
-class mobase.TrackedState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
-

Bases: Enum

-

Attributes Summary

- - - - - - - - - - - - - - - - - - -

TRACKED_FALSE

TRACKED_TRUE

TRACKED_UNKNOWN

name

value

-

Attributes Documentation

-
-
-TRACKED_FALSE = None
-
- -
-
-TRACKED_TRUE = None
-
- -
-
-TRACKED_UNKNOWN = None
-
- -
-
-name
-
- -
-
-value
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.UnmanagedMods.html b/api/mobase.UnmanagedMods.html deleted file mode 100644 index ba3f9c5..0000000 --- a/api/mobase.UnmanagedMods.html +++ /dev/null @@ -1,504 +0,0 @@ - - - - - - - UnmanagedMods — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

UnmanagedMods

-
-
-class mobase.UnmanagedMods
-

Bases: GameFeature

-

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.

-
-
Return type:
-

str

-
-
Parameters:
-

mod_name – Internal name of the mod.

-
-
Returns:
-

The display name of the mod.

-
-
-
- -
-
-abstract mods(official_only)
-

Retrieve the list of unmanaged mods for the corresponding game.

-
-
Return type:
-

Sequence[str]

-
-
Parameters:
-

official_only – Retrieve only unmanaged official mods.

-
-
Returns:
-

The list of unmanaged mods (internal names).

-
-
-
- -
-
-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.

-
-
Return type:
-

Union[str, PathLike[str], QFileInfo]

-
-
Parameters:
-

mod_name – Internal name of the mod.

-
-
Returns:
-

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

-
-
-
- -
-
-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.

-
-
Return type:
-

Sequence[Union[str, PathLike[str], QFileInfo]]

-
-
Parameters:
-

mod_name – Internal name of the mod.

-
-
Returns:
-

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

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.VersionInfo.html b/api/mobase.VersionInfo.html deleted file mode 100644 index 08d3c74..0000000 --- a/api/mobase.VersionInfo.html +++ /dev/null @@ -1,531 +0,0 @@ - - - - - - - VersionInfo — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

VersionInfo

-
-
-class mobase.VersionInfo
-
-class mobase.VersionInfo(value: str, scheme: VersionScheme = VersionScheme.DISCOVER)
-
-class mobase.VersionInfo(major: int, minor: int, subminor: int, subsubminor: int, release_type: ReleaseType = ReleaseType.FINAL)
-
-class mobase.VersionInfo(major: int, minor: int, subminor: int, release_type: ReleaseType = ReleaseType.FINAL)
-

Bases: object

-

Represents the version of a mod or plugin.

-

Methods Summary

- - - - - - - - - - - - - - - - - - - - - -

canonicalString()

clear()

Resets this VersionInfo to an invalid version.

displayString([forced_segments])

isValid()

parse(value[, scheme, is_manual])

Update this VersionInfo by parsing the given string using the given scheme.

scheme()

-

Methods Documentation

-
-
-canonicalString()
-
-
Return type:
-

str

-
-
Returns:
-

A canonical string representing this version, that can be stored and then parsed using the parse() method.

-
-
-
- -
-
-clear()
-

Resets this VersionInfo to an invalid version.

-
-
Return type:
-

None

-
-
-
- -
-
-displayString(forced_segments=2)
-
-
Return type:
-

str

-
-
Parameters:
-

forced_segments – The number of version segments to display even if the version is 0. 1 is major, 2 is major -and minor, etc. The only implemented ranges are (-inf,2] for major/minor, [3] for major/minor/subminor, -and [4,inf) for major/minor/subminor/subsubminor. This only versions with a regular scheme.

-
-
Returns:
-

A string for display to the user. The returned string may not contain enough information to reconstruct this version info.

-
-
-
- -
-
-isValid()
-
-
Return type:
-

bool

-
-
Returns:
-

True if this VersionInfo is valid, False otherwise.

-
-
-
- -
-
-parse(value, scheme=VersionScheme.None, is_manual=False)
-

Update this VersionInfo by parsing the given string using the given scheme.

-
-
Return type:
-

None

-
-
Parameters:
-
    -

  • value – String to parse.

    • -

  • scheme – Scheme to use to parse the string.

    • -

  • is_manual – True if the given string should be treated as user input.

    • -
-
-
-
- -
-
-scheme()
-
-
Return type:
-

VersionScheme

-
-
Returns:
-

The version scheme in effect for this VersionInfo.

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.VersionScheme.html b/api/mobase.VersionScheme.html deleted file mode 100644 index 9af2076..0000000 --- a/api/mobase.VersionScheme.html +++ /dev/null @@ -1,482 +0,0 @@ - - - - - - - VersionScheme — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

VersionScheme

-
-
-class mobase.VersionScheme(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)
-

Bases: Enum

-

Attributes Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - -

DATE

DECIMAL_MARK

DISCOVER

LITERAL

NUMBERS_AND_LETTERS

REGULAR

name

value

-

Attributes Documentation

-
-
-DATE = None
-
- -
-
-DECIMAL_MARK = None
-
- -
-
-DISCOVER = None
-
- -
-
-LITERAL = None
-
- -
-
-NUMBERS_AND_LETTERS = None
-
- -
-
-REGULAR = None
-
- -
-
-name
-
- -
-
-value
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.getFileVersion.html b/api/mobase.getFileVersion.html deleted file mode 100644 index d7c1f00..0000000 --- a/api/mobase.getFileVersion.html +++ /dev/null @@ -1,425 +0,0 @@ - - - - - - - getFileVersion — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

getFileVersion

-
-
-mobase.getFileVersion(filepath)
-

Retrieve the file version of the given executable.

-
-
Return type:
-

str

-
-
Parameters:
-

filepath – Absolute path to the executable.

-
-
Returns:
-

The file version, or an empty string if the file version could not be retrieved.

-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.getIconForExecutable.html b/api/mobase.getIconForExecutable.html deleted file mode 100644 index 88461a3..0000000 --- a/api/mobase.getIconForExecutable.html +++ /dev/null @@ -1,425 +0,0 @@ - - - - - - - getIconForExecutable — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

getIconForExecutable

-
-
-mobase.getIconForExecutable(executable)
-

Retrieve the icon of an executable. Currently this always extracts the biggest icon.

-
-
Return type:
-

QIcon

-
-
Parameters:
-

executable – Absolute path to the executable.

-
-
Returns:
-

The icon for this executable, if any.

-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/api/mobase.getProductVersion.html b/api/mobase.getProductVersion.html deleted file mode 100644 index c25ecd4..0000000 --- a/api/mobase.getProductVersion.html +++ /dev/null @@ -1,425 +0,0 @@ - - - - - - - getProductVersion — MO2 Python Plugin API documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

getProductVersion

-
-
-mobase.getProductVersion(executable)
-

Retrieve the product version of the given executable.

-
-
Return type:
-

str

-
-
Parameters:
-

executable – Absolute path to the executable.

-
-
Returns:
-

The product version, or an empty string if the product version could not be retrieved.

-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/autoapi/index.html b/autoapi/index.html new file mode 100644 index 0000000..5770dd8 --- /dev/null +++ b/autoapi/index.html @@ -0,0 +1,262 @@ + + + + + + + API Reference — MO2 Python Plugin API documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

API Reference

+

This page contains auto-generated API reference documentation [1].

+
+ +
+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/mobase/index.html b/autoapi/mobase/index.html new file mode 100644 index 0000000..849c992 --- /dev/null +++ b/autoapi/mobase/index.html @@ -0,0 +1,7273 @@ + + + + + + + mobase — MO2 Python Plugin API documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

mobase

+
+

Subpackages

+
+ +
+
+
+

Attributes

+ + + + + + + + + + + + + + + +

GameFeatureType

INVALID_HANDLE_VALUE

MoVariant

__version__

+
+
+

Classes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

BSAInvalidation

Base class for all game features, cannot be inherited, used only for typing

DataArchives

Base class for all game features, cannot be inherited, used only for typing

EndorsedState

Create a collection of name/value pairs.

ExecutableForcedLoadSetting

ExecutableInfo

FileInfo

Information about a virtualized file

FileTreeEntry

Represent an entry in a file tree, either a file or a directory. This class

GameFeature

Base class for all game features, cannot be inherited, used only for typing

GamePlugins

Base class for all game features, cannot be inherited, used only for typing

GuessQuality

Describes how good the code considers a guess (i.e. for a mod name) this is used to

GuessedString

Represents a string that may be set from different places. Each time the value is

IDownloadManager

IFileTree

Interface to classes that provides way to visualize and alter file trees. The tree

IGameFeatures

Interface for the game features, accessible through IOrganizer.gameFeatures().

IInstallationManager

IModInterface

IModList

Interface to the mod-list.

IModRepositoryBridge

IOrganizer

Interface to class that provides information about the running session

IPlugin

Base class for all plugins.

IPluginDiagnose

Plugins that create problem reports to be displayed in the UI.

IPluginFileMapper

Plugins that adds virtual file links.

IPluginGame

Base classes for game plugins.

IPluginInstaller

This is the top-level class for installer. Actual installers should inherit either:

IPluginInstallerCustom

Custom installer for mods. Custom installers receive the archive name and have to go

IPluginInstallerSimple

Simple installer for mods. Simple installers only deal with an in-memory structure

IPluginList

Primary interface to the list of plugins.

IPluginModPage

Base class for all plugins.

IPluginPreview

These plugins add support for previewing files in the data pane. Right now all image formats supported

IPluginRequirement

Class representing requirements for plugins.

IPluginTool

This is the simplest of plugin interfaces. Such plugins simply place an icon inside the tools sub-menu

IProfile

Interface to interact with Mod Organizer 2 profiles.

ISaveGame

Base class for information about what is in a save game.

ISaveGameInfoWidget

Base class for a save game info widget.

InstallResult

Create a collection of name/value pairs.

LoadOrderMechanism

Create a collection of name/value pairs.

LocalSavegames

Base class for all game features, cannot be inherited, used only for typing

Mapping

ModDataChecker

Game feature that is used to check the content of a data tree.

ModDataContent

The ModDataContent feature is used (when available) to indicate to users the content

ModRepositoryFileInfo

ModState

Create a collection of name/value pairs.

PluginRequirementFactory

PluginSetting

Class to hold the user-configurable parameters a plugin accepts. The purpose of this class is

PluginState

Create a collection of name/value pairs.

ProfileSetting

Create a collection of name/value pairs.

ReleaseType

Create a collection of name/value pairs.

SaveGameInfo

Feature to get hold of stuff to do with save games.

ScriptExtender

Base class for all game features, cannot be inherited, used only for typing

SortMechanism

Create a collection of name/value pairs.

TrackedState

Create a collection of name/value pairs.

UnmanagedMods

Base class for all game features, cannot be inherited, used only for typing

VersionInfo

Represents the version of a mod or plugin.

VersionScheme

Create a collection of name/value pairs.

+
+
+

Functions

+ + + + + + + + + + + + +

getFileVersion(→ str)

Retrieve the file version of the given executable.

getIconForExecutable(→ PyQt6.QtGui.QIcon)

Retrieve the icon of an executable. Currently this always extracts the biggest icon.

getProductVersion(→ str)

Retrieve the product version of the given executable.

+
+
+

Package Contents

+
+
+class mobase.BSAInvalidation
+

Bases: GameFeature

+

Base class for all game features, cannot be inherited, used only for typing +purpose in Python.

+
+
+abstract activate(profile: IProfile) → None
+
+ +
+
+abstract deactivate(profile: IProfile) → None
+
+ +
+
+abstract isInvalidationBSA(name: str) → bool
+
+ +
+ +
+
+class mobase.DataArchives
+

Bases: GameFeature

+

Base class for all game features, cannot be inherited, used only for typing +purpose in Python.

+
+
+abstract addArchive(profile: IProfile, index: int, name: str) → None
+

Add an archive to the archive list.

+
+
Parameters:
+
    +

  • profile – Profile to add the archive to.

    • +

  • index – Index to insert before. Use 0 for the beginning of the list or INT_MAX for +the end of the list).

    • +

  • name – Name of the archive to add.

    • +
+
+
+
+ +
+
+abstract archives(profile: IProfile) → Sequence[str]
+

Retrieve the list of archives in the given profile.

+
+
Parameters:
+

profile – Profile to retrieve archives from.

+
+
Returns:
+

The list of archives in the given profile.

+
+
+
+ +
+
+abstract removeArchive(profile: IProfile, name: str) → None
+

Remove the given archive from the given profile.

+
+
Parameters:
+
    +

  • profile – Profile to remove the archive from.

    • +

  • name – Name of the archive to remove.

    • +
+
+
+
+ +
+
+abstract vanillaArchives() → Sequence[str]
+

Retrieve the list of vanilla archives.

+

Vanilla archives are archive files that are shipped with the original +game.

+
+
Returns:
+

The list of vanilla archives.

+
+
+
+ +
+ +
+
+class mobase.EndorsedState(*args, **kwds)
+

Bases: enum.Enum

+

Create a collection of name/value pairs.

+

Example enumeration:

+
>>> class Color(Enum):
+...     RED = 1
+...     BLUE = 2
+...     GREEN = 3
+
+
+

Access them by:

+
    +

  • attribute access:

    +
    >>> Color.RED
+<Color.RED: 1>
+
    +
    +
    • +

  • value lookup:

    +
    >>> Color(1)
+<Color.RED: 1>
+
    +
    +
    • +

  • name lookup:

    +
    >>> Color['RED']
+<Color.RED: 1>
+
    +
    +
    • +
+

Enumerations can be iterated over, and know how many members they have:

+
>>> len(Color)
+3
+
+
+
>>> list(Color)
+[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]
+
+
+

Methods can be added to enumerations, and members can have their own +attributes – see the documentation for details.

+
+
+__eq__(other: object) → bool
+

Return self==value.

+
+ +
+
+__ge__(other: EndorsedState) → bool
+

Return self>=value.

+
+ +
+
+__gt__(other: EndorsedState) → bool
+

Return self>value.

+
+ +
+
+__int__() → int
+
+ +
+
+__le__(other: EndorsedState) → bool
+

Return self<=value.

+
+ +
+
+__lt__(other: EndorsedState) → bool
+

Return self<value.

+
+ +
+
+__ne__(other: object) → bool
+

Return self!=value.

+
+ +
+
+__str__() → str
+

Return str(self).

+
+ +
+
+ENDORSED_FALSE = Ellipsis
+
+ +
+
+ENDORSED_NEVER = Ellipsis
+
+ +
+
+ENDORSED_TRUE = Ellipsis
+
+ +
+
+ENDORSED_UNKNOWN = Ellipsis
+
+ +
+
+property name: str
+

The name of the Enum member.

+
+ +
+
+property value: int
+

The value of the Enum member.

+
+ +
+ +
+
+class mobase.ExecutableForcedLoadSetting(process: str, library: str)
+
+
+enabled() → bool
+
+ +
+
+forced() → bool
+
+ +
+
+library() → str
+
+ +
+
+process() → str
+
+ +
+
+withEnabled(enabled: bool) → ExecutableForcedLoadSetting
+
+ +
+
+withForced(forced: bool) → ExecutableForcedLoadSetting
+
+ +
+ +
+
+class mobase.ExecutableInfo(title: str, binary: str | os.PathLike[str] | PyQt6.QtCore.QFileInfo)
+
+
+arguments() → Sequence[str]
+
+ +
+
+asCustom() → ExecutableInfo
+
+ +
+
+binary() → PyQt6.QtCore.QFileInfo
+
+ +
+
+isCustom() → bool
+
+ +
+
+isValid() → bool
+
+ +
+
+steamAppID() → str
+
+ +
+
+title() → str
+
+ +
+
+withArgument(argument: str) → ExecutableInfo
+
+ +
+
+withSteamAppId(app_id: str) → ExecutableInfo
+
+ +
+
+withWorkingDirectory(directory: str | os.PathLike[str] | PyQt6.QtCore.QDir) → ExecutableInfo
+
+ +
+
+workingDirectory() → PyQt6.QtCore.QDir
+
+ +
+ +
+
+class mobase.FileInfo
+

Information about a virtualized file

+
+
+property archive: str
+
+ +
+
+property filePath: str
+
+ +
+
+property origins: list[str]
+
+ +
+ +
+
+class mobase.FileTreeEntry
+

Represent an entry in a file tree, either a file or a directory. This class +inherited by IFileTree so that operations on entry are the same for a file or +a directory.

+

This class provides convenience methods to query information on the file, like its +name or the its last modification time. It also provides a convenience astree() method +that can be used to retrieve the tree corresponding to its entry in case the entry +represent a directory.

+
+
+class FileTypes(*args, **kwds)
+

Bases: enum.Enum

+

Enumeration of the different file type or combinations.

+
+
+__and__(other: FileTreeEntry) → FileTreeEntry
+
+ +
+
+__eq__(other: object) → bool
+

Return self==value.

+
+ +
+
+__ge__(other: FileTreeEntry) → bool
+

Return self>=value.

+
+ +
+
+__gt__(other: FileTreeEntry) → bool
+

Return self>value.

+
+ +
+
+__int__() → int
+
+ +
+
+__invert__() → FileTreeEntry
+
+ +
+
+__le__(other: FileTreeEntry) → bool
+

Return self<=value.

+
+ +
+
+__lt__(other: FileTreeEntry) → bool
+

Return self<value.

+
+ +
+
+__ne__(other: object) → bool
+

Return self!=value.

+
+ +
+
+__or__(other: FileTreeEntry) → FileTreeEntry
+
+ +
+
+__rand__(other: FileTreeEntry) → FileTreeEntry
+
+ +
+
+__ror__(other: FileTreeEntry) → FileTreeEntry
+
+ +
+
+__rxor__(other: FileTreeEntry) → FileTreeEntry
+
+ +
+
+__str__() → str
+

Return str(self).

+
+ +
+
+__xor__(other: FileTreeEntry) → FileTreeEntry
+
+ +
+
+DIRECTORY = Ellipsis
+
+ +
+
+FILE = Ellipsis
+
+ +
+
+FILE_OR_DIRECTORY = Ellipsis
+
+ +
+
+property name: str
+

The name of the Enum member.

+
+ +
+
+property value: int
+

The value of the Enum member.

+
+ +
+ +
+
+__eq__(other: object) → bool
+

Return self==value.

+
+ +
+
+detach() → bool
+

Detach this entry from its parent tree.

+
+
Returns:
+

True if the entry was removed correctly, False otherwise.

+
+
+
+ +
+
+fileType() → FileTreeEntry
+
+
Returns:
+

The filetype of this entry.

+
+
+
+ +
+
+hasSuffix(suffixes: Sequence[str]) → bool
+
+hasSuffix(suffix: str) → bool
+

Check if this entry has the given suffix.

+
+
Parameters:
+

suffix – Suffix to check.

+
+
Returns:
+

True if this entry is a file and has the given suffix.

+
+
+
+ +
+
+isDir() → bool
+
+
Returns:
+

True if this entry is a directory, False otherwise.

+
+
+
+ +
+
+isFile() → bool
+
+
Returns:
+

True if this entry is a file, False otherwise.

+
+
+
+ +
+
+moveTo(tree: IFileTree) → bool
+

Move this entry to the given tree.

+
+
Parameters:
+

tree – The tree to move this entry to.

+
+
Returns:
+

True if the entry was moved correctly, False otherwise.

+
+
+
+ +
+
+name() → str
+
+
Returns:
+

The name of this entry.

+
+
+
+ +
+
+parent() → IFileTree | None
+
+
Returns:
+

The parent tree containing this entry, or a None if this entry is the root

+
+
+

or the parent tree is unreachable.

+
+ +
+
+path(sep: str = '\\') → str
+

Retrieve the path from this entry up to the root of the tree.

+

This method propagate up the tree so is not constant complexity as +the full path is never stored.

+
+
Parameters:
+

sep – The type of separator to use to create the path.

+
+
Returns:
+

The path from this entry to the root, including the name of this entry.

+
+
+
+ +
+
+pathFrom(tree: IFileTree, sep: str = '\\') → str
+

Retrieve the path from the given tree to this entry.

+
+
Parameters:
+
    +

  • tree – The tree to reach, must be a parent of this entry.

    • +

  • sep – The type of separator to use to create the path.

    • +
+
+
Returns:
+

The path from the given tree to this entry, including the name of this entry, or

+
+
+

an empty string if the given tree is not a parent of this entry.

+
+ +
+
+suffix() → str
+

Retrieve the “last” extension of this entry.

+

The “last” extension is everything after the last dot in the file name.

+
+
Returns:
+

The last extension of this entry, or an empty string if the file has no extension

+
+
+

or is directory.

+
+ +
+
+DIRECTORY: FileTreeEntry.FileTypes = Ellipsis
+
+ +
+
+FILE: FileTreeEntry.FileTypes = Ellipsis
+
+ +
+
+FILE_OR_DIRECTORY: FileTreeEntry.FileTypes = Ellipsis
+
+ +
+ +
+
+class mobase.GameFeature
+

Bases: abc.ABC

+

Base class for all game features, cannot be inherited, used only for typing +purpose in Python.

+
+ +
+
+class mobase.GamePlugins
+

Bases: GameFeature

+

Base class for all game features, cannot be inherited, used only for typing +purpose in Python.

+
+
+abstract getLoadOrder() → Sequence[str]
+
+ +
+
+abstract lightPluginsAreSupported() → bool
+
+
Returns:
+

True if light plugins are supported, False otherwise.

+
+
+
+ +
+
+abstract mediumPluginsAreSupported() → bool
+
+
Returns:
+

True if medium plugins are supported, False otherwise.

+
+
+
+ +
+
+abstract readPluginLists(plugin_list: IPluginList) → None
+
+ +
+
+abstract writePluginLists(plugin_list: IPluginList) → None
+
+ +
+ +
+
+class mobase.GuessQuality(*args, **kwds)
+

Bases: enum.Enum

+

Describes how good the code considers a guess (i.e. for a mod name) this is used to +determine if a name from another source should overwrite or not.

+
+
+__eq__(other: object) → bool
+

Return self==value.

+
+ +
+
+__int__() → int
+
+ +
+
+__ne__(other: object) → bool
+

Return self!=value.

+
+ +
+
+__str__() → str
+

Return str(self).

+
+ +
+
+FALLBACK = Ellipsis
+
+ +
+
+GOOD = Ellipsis
+
+ +
+
+INVALID = Ellipsis
+
+ +
+
+META = Ellipsis
+
+ +
+
+PRESET = Ellipsis
+
+ +
+
+USER = Ellipsis
+
+ +
+
+property name: str
+

The name of the Enum member.

+
+ +
+
+property value: int
+

The value of the Enum member.

+
+ +
+ +
+
+class mobase.GuessedString
+
+class mobase.GuessedString(value: str, quality: GuessQuality = GuessQuality.USER)
+

Represents a string that may be set from different places. Each time the value is +changed a “quality” is specified to say how probable it is the value is the best choice. +Only the best choice should be used in the end but alternatives can be queried. This +class also allows a filter to be set. If a “guess” doesn’t pass the filter, it is ignored.

+
+
+__str__() → str
+

Return str(self).

+
+ +
+
+reset() → GuessedString
+
+reset(value: str, quality: GuessQuality) → GuessedString
+
+reset(other: GuessedString) → GuessedString
+

Reset this GuessedString object by copying the given one, only +if the given one has better quality.

+
+
Parameters:
+

other – The GuessedString to copy.

+
+
Returns:
+

This GuessedString object.

+
+
+
+ +
+
+setFilter(filter: Callable[[str], str | bool]) → None
+

Set the filter for this GuessedString.

+

The filter is applied on every update() and can reject the new value +altogether or modify it (by returning a new value).

+
+
Parameters:
+

filter – The new filter.

+
+
+
+ +
+
+update(value: str) → GuessedString
+
+update(value: str, quality: GuessQuality) → GuessedString
+

Update this GuessedString by adding a new variants with the given quality.

+

If the specified quality is better than the current one, the actual value of +the GuessedString is also updated.

+

The GuessedString is only updated if the given value passes the filter.

+
+
Parameters:
+
    +

  • value – The new variant to add.

    • +

  • quality – The quality of the variant.

    • +
+
+
Returns:
+

This GuessedString object.

+
+
+
+ +
+
+variants() → set[str]
+
+
Returns:
+

The list of variants for this GuessedString.

+
+
+
+ +
+ +
+
+class mobase.IDownloadManager
+
+
+downloadPath(id: int) → str
+

Retrieve the (absolute) path of the specified download.

+
+
Parameters:
+

id – ID of the download.

+
+
Returns:
+

The absolute path to the file corresponding to the given download. This file

+
+
+

may not exist yet if the download is incomplete.

+
+ +
+
+onDownloadComplete(callback: Callable[[int], None]) → bool
+

Installs a handler to be called when a download completes.

+
+
Parameters:
+

callback – The function to be called when a download complete. The parameter is the download ID.

+
+
Returns:
+

True if the handler was installed properly (there are currently no reasons for this to fail).

+
+
+
+ +
+
+onDownloadFailed(callback: Callable[[int], None]) → bool
+

Installs a handler to be called when a download fails.

+
+
Parameters:
+

callback – The function to be called when a download fails. The parameter is the download ID.

+
+
Returns:
+

True if the handler was installed properly (there are currently no reasons for this to fail).

+
+
+
+ +
+
+onDownloadPaused(callback: Callable[[int], None]) → bool
+

Installs a handler to be called when a download is paused.

+
+
Parameters:
+

callback – The function to be called when a download is paused. The parameter is the download ID.

+
+
Returns:
+

True if the handler was installed properly (there are currently no reasons for this to fail).

+
+
+
+ +
+
+onDownloadRemoved(callback: Callable[[int], None]) → bool
+

Installs a handler to be called when a download is removed.

+
+
Parameters:
+

callback – The function to be called when a download is removed. The parameter is the download ID.

+
+
Returns:
+

True if the handler was installed properly (there are currently no reasons for this to fail).

+
+
+
+ +
+
+startDownloadNexusFile(mod_id: int, file_id: int) → int
+

Download a file from www.nexusmods.com/<game>. <game> is always the game +currently being managed.

+
+
Parameters:
+
    +

  • mod_id – ID of the mod to download the file from.

    • +

  • file_id – ID of the file to download.

    • +
+
+
Returns:
+

An ID identifying the download.

+
+
+
+ +
+
+startDownloadURLs(urls: Sequence[str]) → int
+

Download a file by url.

+

The list can contain alternative URLs to allow the download manager to switch +in case of download problems

+
+
Parameters:
+

urls – List of urls to download from.

+
+
Returns:
+

An ID identifying the download.

+
+
+
+ +
+ +
+
+class mobase.IFileTree
+

Bases: FileTreeEntry

+

Interface to classes that provides way to visualize and alter file trees. The tree +may not correspond to an actual file tree on the disk (e.g., inside an archive, +from a QTree Widget, …).

+

Read-only operations on the tree are thread-safe, even when the tree has not been populated +yet.

+

In order to prevent wrong usage of the tree, implementing classes may throw +UnsupportedOperationException if an operation is not supported. By default, all operations +are supported, but some may not make sense in many situations.

+

The goal of this is not reflect the change made to a IFileTree to the disk, but child +classes may override relevant methods to do so.

+

The tree is built upon FileTreeEntry. A given tree holds shared pointers to its entries +while each entry holds a weak pointer to its parent, this means that the descending link +are strong (shared pointers) but the uplink are weak.

+

Accessing the parent is always done by locking the weak pointer so that returned pointer +or either null or valid. This structure implies that as long as the initial root lives, +entry should not be destroyed, unless the entry are detached from the root and no shared +pointers are kept.

+

However, it is not guarantee that one can go up the tree from a single node entry. If the +root node is destroyed, it will not be possible to go up the tree, even if we still have +a valid shared pointer.

+
+
+class InsertPolicy(*args, **kwds)
+

Bases: enum.Enum

+

Create a collection of name/value pairs.

+

Example enumeration:

+
>>> class Color(Enum):
+...     RED = 1
+...     BLUE = 2
+...     GREEN = 3
+
+
+

Access them by:

+
    +

  • attribute access:

    +
    >>> Color.RED
+<Color.RED: 1>
+
    +
    +
    • +

  • value lookup:

    +
    >>> Color(1)
+<Color.RED: 1>
+
    +
    +
    • +

  • name lookup:

    +
    >>> Color['RED']
+<Color.RED: 1>
+
    +
    +
    • +
+

Enumerations can be iterated over, and know how many members they have:

+
>>> len(Color)
+3
+
+
+
>>> list(Color)
+[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]
+
+
+

Methods can be added to enumerations, and members can have their own +attributes – see the documentation for details.

+
+
+__eq__(other: object) → bool
+

Return self==value.

+
+ +
+
+__int__() → int
+
+ +
+
+__ne__(other: object) → bool
+

Return self!=value.

+
+ +
+
+__str__() → str
+

Return str(self).

+
+ +
+
+FAIL_IF_EXISTS = Ellipsis
+
+ +
+
+MERGE = Ellipsis
+
+ +
+
+REPLACE = Ellipsis
+
+ +
+
+property name: str
+

The name of the Enum member.

+
+ +
+
+property value: int
+

The value of the Enum member.

+
+ +
+ +
+
+class WalkReturn(*args, **kwds)
+

Bases: enum.Enum

+

Enumeration that can be returned by the callback for the walk() method to stop the +walking operation early.

+
+
+__eq__(other: object) → bool
+

Return self==value.

+
+ +
+
+__int__() → int
+
+ +
+
+__ne__(other: object) → bool
+

Return self!=value.

+
+ +
+
+__str__() → str
+

Return str(self).

+
+ +
+
+CONTINUE = Ellipsis
+
+ +
+
+SKIP = Ellipsis
+
+ +
+
+STOP = Ellipsis
+
+ +
+
+property name: str
+

The name of the Enum member.

+
+ +
+
+property value: int
+

The value of the Enum member.

+
+ +
+ +
+
+__bool__() → bool
+
+
Returns:
+

True if this tree is not empty, False otherwise.

+
+
+
+ +
+
+__getitem__(index: int) → FileTreeEntry
+

Retrieve the entry at the given index in this tree.

+
+
Parameters:
+

index – Index of the entry to retrieve, must be less than the size.

+
+
Returns:
+

The entry at the given index.

+
+
Raises:
+

IndexError – If the given index is not in range for this tree.

+
+
+
+ +
+
+__iter__() → Iterator[FileTreeEntry]
+

Retrieves an iterator for entries directly under this tree.

+

This method does not recurse into subtrees, see walk() for this.

+
+
Returns:
+

An iterator object that can be used to iterate over entries in this tree.

+
+
+
+ +
+
+__len__() → int
+
+
Returns:
+

The number of entries directly under this tree.

+
+
+
+ +
+
+addDirectory(path: str) → IFileTree
+

Create a new directory tree under this tree.

+

This method will create missing folders in the given path and will +not fail if the directory already exists but will fail if the given +path contains “.” or “..”. +This method invalidates iterators to this tree and all the subtrees +present in the given path.

+
+
Parameters:
+

path – Path to the directory to create.

+
+
Returns:
+

An IFileTree corresponding to the created directory.

+
+
Raises:
+

RuntimeError – If the directory could not be created.

+
+
+
+ +
+
+addFile(path: str, replace_if_exists: bool = False) → FileTreeEntry
+

Create a new file directly under this tree.

+

This method will fail if the file already exists and replace_if_exists is False. +This method invalidates iterators to this tree and all the subtrees present in the +given path.

+
+
Parameters:
+
    +

  • path – Path to the file to create.

    • +

  • replace_if_exists – If True and an entry already exists at the given location, it will be replaced by +a new entry. This will replace both files and directories.

    • +
+
+
Returns:
+

A FileTreeEntry corresponding to the created file.

+
+
Raises:
+

RuntimeError – If the file could not be created.

+
+
+
+ +
+
+clear() → bool
+

Delete (detach) all the entries from this tree.

+

This method will go through the entries in this tree and stop at the first +entry that cannot be deleted, this means that the tree can be partially cleared.

+
+
Returns:
+

True if all entries have been detached, False otherwise.

+
+
+
+ +
+
+copy(entry: FileTreeEntry, path: str = '', insert_policy: IFileTree = InsertPolicy.FAIL_IF_EXISTS) → FileTreeEntry
+

Move the given entry to the given path under this tree.

+

The entry must not be a parent tree of this tree. This method can also be used +to rename entries.

+

If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry +at the same location already exists. If the policy is REPLACE, an existing +entry will be replaced. If MERGE, the entry will be merged with the existing +one (if the entry is a file, and a file exists, the file will be replaced).

+

This method invalidates iterator to this tree, to the parent tree of the given +entry, and to subtrees of this tree if the insert policy is MERGE.

+
+
Parameters:
+
    +

  • entry – Entry to copy.

    • +

  • path – The path to copy the entry to. If the path ends with / or , the entry will +be copied in the corresponding directory instead of replacing it. If the +given path is empty (“”), the entry is copied directly under this tree.

    • +

  • insert_policy – Policy to use to resolve conflicts.

    • +
+
+
Returns:
+

The new entry (copy of the specified entry).

+
+
Raises:
+

RuntimeError – If the entry could not be copied.

+
+
+
+ +
+
+createOrphanTree(name: str = '') → IFileTree
+

Create a new orphan empty tree.

+
+
Parameters:
+

name – Name of the tree.

+
+
Returns:
+

A new tree without any parent.

+
+
+
+ +
+
+exists(path: str, type: FileTreeEntry = FileTreeEntry.FileTypes.FILE_OR_DIRECTORY) → bool
+

Check if the given entry exists.

+
+
Parameters:
+
    +

  • path – Path to the entry, separated by / or .

    • +

  • type – The type of the entry to check.

    • +
+
+
Returns:
+

True if the entry was found, False otherwise.

+
+
+
+ +
+
+find(path: str, type: FileTreeEntry = FileTreeEntry.FileTypes.FILE_OR_DIRECTORY) → IFileTree | FileTreeEntry | None
+

Retrieve the given entry.

+

If no entry exists at the given path, or if the entry is not of the right +type, None is returned.

+
+
Parameters:
+
    +

  • path – Path to the entry, separated by / or .

    • +

  • type – The type of the entry to check.

    • +
+
+
Returns:
+

The entry at the given location, or None if the entry was not found or

+
+
+

was not of the correct type.

+
+ +
+
+insert(entry: FileTreeEntry, policy: IFileTree = InsertPolicy.FAIL_IF_EXISTS) → bool
+

Insert the given entry in this tree, removing it from its +previous parent.

+

The entry must not be this tree or a parent entry of this tree.

+
+
    +

  • If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry +with the same name already exists.

    • +

  • If the policy is REPLACE, an existing entry will be replaced by the given entry.

    • +

  • If the policy is MERGE:

    +
      +

    • If there is no entry with the same name, the new entry is inserted.

      • +

    • If there is an entry with the same name:

      +
        +

      • If both entries are files, the old file is replaced by the given entry.

        • +

      • If both entries are directories, a merge is performed as if using merge().

        • +

      • Otherwise the insertion fails (two entries with different types).

        • +
      +
      • +
    +
    • +
+
+

This method invalidates iterator to this tree, to the parent tree of the given +entry, and to subtrees of this tree if the insert policy is MERGE.

+
+
Parameters:
+
    +

  • entry – Entry to insert.

    • +

  • policy – Policy to use to resolve conflicts.

    • +
+
+
Returns:
+

True if the entry was insert, False otherwise.

+
+
+
+ +
+
+merge(other: IFileTree, overwrites: bool = False) → dict[FileTreeEntry, FileTreeEntry] | int
+

Merge the given tree with this tree, i.e., insert all entries +of the given tree into this tree.

+

The tree must not be this tree or a parent entry of this tree. Files present in both tree +will be replaced by files in the given tree. After a merge, the source tree will be +empty but still attached to its parent.

+

If overwrites is True, a map from overridden files to new files will be returned.

+

Note that the merge process makes no distinction between files and directories +when merging: if a directory is present in this tree and a file from source +is in conflict with it, the tree will be removed and the file inserted; if a file +is in this tree and a directory from source is in conflict with it, the file will +be replaced with the directory.

+

This method invalidates iterators to this tree, all the subtrees under this tree +present in the given path, and all the subtrees of the given source.

+
+
Parameters:
+
    +

  • other – Tree to merge.

    • +

  • overwrites – If True, a mapping from overridden files to new files will be returned.

    • +
+
+
Returns:
+

If overwrites is True, a mapping from overridden files to new files, otherwise

+
+
+

the number of overwritten entries.

+
+
Raises:
+

RuntimeError – If the merge failed.

+
+
+
+ +
+
+move(entry: FileTreeEntry, path: str, policy: IFileTree = InsertPolicy.FAIL_IF_EXISTS) → bool
+

Move the given entry to the given path under this tree.

+

The entry must not be a parent tree of this tree. This method can also be used +to rename entries.

+

If the insert policy if FAIL_IF_EXISTS, the call will fail if an entry +at the same location already exists. If the policy is REPLACE, an existing +entry will be replaced. If MERGE, the entry will be merged with the existing +one (if the entry is a file, and a file exists, the file will be replaced).

+

This method invalidates iterator to this tree, to the parent tree of the given +entry, and to subtrees of this tree if the insert policy is MERGE.

+
+
Parameters:
+
    +

  • entry – Entry to move.

    • +

  • path – The path to move the entry to. If the path ends with / or , the entry will +be inserted in the corresponding directory instead of replacing it. If the +given path is empty (“”), this is equivalent to insert().

    • +

  • policy – Policy to use to resolve conflicts.

    • +
+
+
Returns:
+

True if the entry was moved correctly, False otherwise.

+
+
+
+ +
+
+pathTo(entry: FileTreeEntry, sep: str = '\\') → str
+

Retrieve the path from this tree to the given entry.

+
+
Parameters:
+
    +

  • entry – The entry to reach, must be in this tree.

    • +

  • sep – The type of separator to use to create the path.

    • +
+
+
Returns:
+

The path from this tree to the given entry, including the name of the entry, or

+
+
+

an empty string if the given entry was not found under this tree.

+
+ +
+
+remove(name: str) → bool
+
+remove(entry: FileTreeEntry) → bool
+

Delete the given entry.

+
+
Parameters:
+

entry – Entry to delete. The entry must belongs to this tree (and not to a subtree).

+
+
Returns:
+

True if the entry was deleted, False otherwise.

+
+
+
+ +
+
+removeAll(names: Sequence[str]) → int
+

Delete the entries with the given names from the tree.

+

This method does not recurse into subtrees, so only entries accessible +directly from this tree will be removed. This method invalidates iterators.

+
+
Parameters:
+

names – Names of the entries to delete.

+
+
Returns:
+

The number of deleted entry.

+
+
+
+ +
+
+removeIf(filter: Callable[[FileTreeEntry], bool]) → int
+

Delete entries matching the given predicate from the tree.

+

This method does not recurse into subtrees, so only entries accessible +directly from this tree will be removed. This method invalidates iterators.

+
+
Parameters:
+

filter – Predicate that should return true for entries to delete.

+
+
Returns:
+

The number of deleted entry.

+
+
+
+ +
+
+walk(callback: Callable[[str, FileTreeEntry], IFileTree], sep: str = '\\') → None
+

Walk this tree, calling the given function for each entry in it.

+

The given callback will be called with two parameters: the path from this tree to the given entry +(with a trailing separator, not including the entry name), and the actual entry. The method returns +a WalkReturn object to indicates what to do.

+
+
Parameters:
+
    +

  • callback – Method to call for each entry in the tree.

    • +

  • sep – Type of separator to use to construct the path.

    • +
+
+
+
+ +
+
+CONTINUE: IFileTree.WalkReturn = Ellipsis
+
+ +
+
+FAIL_IF_EXISTS: IFileTree.InsertPolicy = Ellipsis
+
+ +
+
+MERGE: IFileTree.InsertPolicy = Ellipsis
+
+ +
+
+REPLACE: IFileTree.InsertPolicy = Ellipsis
+
+ +
+
+SKIP: IFileTree.WalkReturn = Ellipsis
+
+ +
+
+STOP: IFileTree.WalkReturn = Ellipsis
+
+ +
+ +
+
+class mobase.IGameFeatures
+

Interface for the game features, accessible through IOrganizer.gameFeatures().

+
+
+gameFeature(feature_type: Type[GameFeatureType]) → GameFeatureType
+

Retrieve the given game feature, if one exists.

+
+
Parameters:
+

feature_type – The class of feature to retrieve.

+
+
Returns:
+

The game feature corresponding to the given type, or None if the feature is

+
+
+

not available.

+
+ +
+
+registerFeature(games: Sequence[str], feature: GameFeature, priority: int, replace: bool = False) → bool
+
+registerFeature(game: IPluginGame, feature: GameFeature, priority: int, replace: bool = False) → bool
+
+registerFeature(feature: GameFeature, priority: int, replace: bool = False) → bool
+

Register game feature for all games.

+

This method register a game feature to combine or replace with other features +of the same kind. Some features are merged (e.g., ModDataContent, +ModDataChecker), while other override previous features (e.g., SaveGameInfo).

+

For features that can be combined, the priority argument indicates the order of +priority (e.g., the order of the checks for ModDataChecker). For other features, +the feature with the highest priority will be used. The features provided by the +game plugin itself always have lowest priority.

+

The feature is associated to the plugin that registers it, if the plugin is +disabled, the feature will not be available.

+

This function will return True if the feature was registered, even if the +feature is not used du to its low priority.

+
+
Parameters:
+
    +

  • feature – Game feature to register.

    • +

  • priority – Priority of the game feature. If the plugin registering the feature +is a game plugin, this parameter is ignored.

    • +

  • replace – If True, remove features of the same kind registered by the current plugin, +otherwise add the feature alongside existing ones.

    • +
+
+
Returns:
+

True if the game feature was properly registered, False otherwise.

+
+
+
+ +
+
+unregisterFeature(feature: GameFeature) → bool
+

Unregister the given game feature.

+

This function is safe to use even if the given feature was never registered.

+
+
Parameters:
+

feature – Feature to unregister.

+
+
Returns:
+

True if the feature was successfully unregistered, False otherwise.

+
+
+
+ +
+
+unregisterFeatures(feature_type: Type[GameFeatureType]) → int
+

Unregister all features of the given type registered by the calling plugin.

+

This function is safe to use even if the plugin has no feature of the given type +register.

+
+
Parameters:
+

feature_type – The class of feature to unregister.

+
+
Returns:
+

The number of unregistered features.

+
+
+
+ +
+ +
+
+class mobase.IInstallationManager
+
+
+createFile(entry: FileTreeEntry) → str
+

Create a new file on the disk corresponding to the given entry.

+

This method can be used by installer that needs to create files that are not in the original +archive. At the end of the installation, if there are entries in the final tree that were used +to create files, the corresponding files will be moved to the mod folder.

+

Temporary files corresponding to created files are automatically cleaned up at the end of +the installation.

+
+
Parameters:
+

entry – The entry for which a temporary file should be created.

+
+
Returns:
+

The path to the created file, or an empty string if the file could not be created.

+
+
+
+ +
+
+extractFile(entry: FileTreeEntry, silent: bool = False) → str
+

Extract the specified file from the currently opened archive to a temporary +location.

+

This method cannot be used to extract directory.

+

The call will fail with an exception if no archive is open (plugins deriving from +IPluginInstallerSimple can rely on that, custom installers should not). The temporary +file is automatically cleaned up after the installation. This call can be very slow +if the archive is large and “solid”.

+
+
Parameters:
+
    +

  • entry – Entry corresponding to the file to extract.

    • +

  • silent – If true, the dialog showing extraction progress will not be shown.

    • +
+
+
Returns:
+

The absolute path to the temporary file, or an empty string if the file was not extracted.

+
+
+
+ +
+
+extractFiles(entries: list[FileTreeEntry], silent: bool = False) → Sequence[str]
+

Extract the specified files from the currently opened archive to a temporary +location.

+

This method cannot be used to extract directories.

+

The call will fail with an exception if no archive is open (plugins deriving from +IPluginInstallerSimple can rely on that, custom installers should not). The temporary +files are automatically cleaned up after the installation. This call can be very slow +if the archive is large and “solid”.

+
+
Parameters:
+
    +

  • entries – Entries corresponding to the files to extract.

    • +

  • silent – If true, the dialog showing extraction progress will not be shown.

    • +
+
+
Returns:
+

A list containing absolute paths to the temporary files.

+
+
+
+ +
+
+getSupportedExtensions() → Sequence[str]
+
+
Returns:
+

The extensions of archives supported by this installation manager.

+
+
+
+ +
+
+installArchive(mod_name: GuessedString, archive: str | os.PathLike[str] | PyQt6.QtCore.QFileInfo, mod_id: int = 0) → tuple[InstallResult, str, int]
+

Install the given archive.

+
+
Parameters:
+
    +

  • mod_name – Suggested name of the mod.

    • +

  • archive – Path to the archive to install.

    • +

  • mod_id – ID of the mod, if available.

    • +
+
+
Returns:
+

The result of the installation.

+
+
+
+ +
+ +
+
+class mobase.IModInterface
+
+
+absolutePath() → str
+
+
Returns:
+

Absolute path to the mod to be used in file system operations.

+
+
+
+ +
+
+addCategory(name: str) → None
+

Assign a category to the mod. If the named category does not exist it is created.

+
+
Parameters:
+

name – Name of the new category to assign.

+
+
+
+ +
+
+addNexusCategory(category_id: int) → None
+

Set the category id from a nexus category id. Conversion to MO ID happens internally.

+

If a mapping is not possible, the category is set to the default value.

+
+
Parameters:
+

category_id – The Nexus category ID.

+
+
+
+ +
+
+categories() → Sequence[str]
+
+
Returns:
+

The list of categories this mod belongs to.

+
+
+
+ +
+
+clearPluginSettings(plugin_name: str) → dict[str, MoVariant]
+

Remove all the settings of the specified plugin this mod.

+
+
Parameters:
+

plugin_name – Name of the plugin for which settings should be removed. This should always be IPlugin.name() +unless you have a really good reason to access settings of another plugin.

+
+
Returns:
+

The old settings from the given plugin, as returned by pluginSettings().

+
+
+
+ +
+
+color() → PyQt6.QtGui.QColor
+
+
Returns:
+

The color of the ‘Notes’ column chosen by the user.

+
+
+
+ +
+
+comments() → str
+
+
Returns:
+

The comments for this mod, if any.

+
+
+
+ +
+
+converted() → bool
+

Check if the mod was marked as converted by the user.

+

When a mod is for a different game, a flag is shown to users to warn them, but +they can mark mods as converted to remove this flag.

+
+
Returns:
+

True if this mod was marked as converted by the user.

+
+
+
+ +
+
+endorsedState() → EndorsedState
+
+
Returns:
+

The endorsement state of this mod.

+
+
+
+ +
+
+fileTree() → IFileTree
+

Retrieve a file tree corresponding to the underlying disk content of this mod.

+

The file tree should not be cached by plugins since it is already and updated when +required.

+
+
Returns:
+

A file tree representing the content of this mod.

+
+
+
+ +
+
+gameName() → str
+

Retrieve the short name of the game associated with this mod. This may differ +from the current game plugin (e.g. you can install a Skyrim LE game in a SSE +installation).

+
+
Returns:
+

The name of the game associated with this mod.

+
+
+
+ +
+
+ignoredVersion() → VersionInfo
+
+
Returns:
+

The ignored version of this mod (for update), or an invalid version if the user

+
+
+

did not ignore version for this mod.

+
+ +
+
+installationFile() → str
+
+
Returns:
+

The absolute path to the file that was used to install this mod.

+
+
+
+ +
+
+isBackup() → bool
+
+
Returns:
+

True if this mod represents a backup.

+
+
+
+ +
+
+isForeign() → bool
+
+
Returns:
+

True if this mod represents a foreign mod, not managed by MO2.

+
+
+
+ +
+
+isOverwrite() → bool
+
+
Returns:
+

True if this mod represents the overwrite mod.

+
+
+
+ +
+
+isSeparator() → bool
+
+
Returns:
+

True if this mod represents a separator.

+
+
+
+ +
+
+name() → str
+
+
Returns:
+

The name of this mod.

+
+
+
+ +
+
+newestVersion() → VersionInfo
+
+
Returns:
+

The newest version of this mod (as known by MO2). If this matches version(),

+
+
+

then the mod is up-to-date.

+
+ +
+
+nexusId() → int
+
+
Returns:
+

The Nexus ID of this mod.

+
+
+
+ +
+
+notes() → str
+
+
Returns:
+

The notes for this mod, if any.

+
+
+
+ +
+
+pluginSetting(plugin_name: str, key: str, default: MoVariant = None) → MoVariant
+

Retrieve the specified setting in this mod for a plugin.

+
+
Parameters:
+
    +

  • plugin_name – Name of the plugin for which to retrieve a setting. This should always be IPlugin.name() +unless you have a really good reason to access settings of another plugin.

    • +

  • key – Identifier of the setting.

    • +

  • default – The default value to return if the setting does not exist.

    • +
+
+
Returns:
+

The setting, if found, or the default value.

+
+
+
+ +
+
+pluginSettings(plugin_name: str) → dict[str, MoVariant]
+

Retrieve the settings in this mod for a plugin.

+
+
Parameters:
+

plugin_name – Name of the plugin for which to retrieve settings. This should always be IPlugin.name() +unless you have a really good reason to access settings of another plugin.

+
+
Returns:
+

A map from setting key to value. The map is empty if there are not settings for this mod.

+
+
+
+ +
+
+primaryCategory() → int
+
+
Returns:
+

The ID of the primary category of this mod.

+
+
+
+ +
+
+removeCategory(name: str) → bool
+

Unassign a category from this mod.

+
+
Parameters:
+

name – Name of the category to remove.

+
+
Returns:
+

True if the category was removed, False otherwise (e.g. if no such category

+
+
+

was assigned).

+
+ +
+
+repository() → str
+
+
Returns:
+

The name of the repository from which this mod was installed.

+
+
+
+ +
+
+setGameName(name: str) → None
+

Set the source game of this mod.

+
+
Parameters:
+

name – The new source game short name of this mod.

+
+
+
+ +
+
+setIsEndorsed(endorsed: bool) → None
+

Set endorsement state of the mod.

+
+
Parameters:
+

endorsed – New endorsement state of this mod.

+
+
+
+ +
+
+setNewestVersion(version: VersionInfo) → None
+

Set the latest known version of this mod.

+
+
Parameters:
+

version – The latest known version of this mod.

+
+
+
+ +
+
+setNexusID(nexus_id: int) → None
+

Set the Nexus ID of this mod.

+
+
Parameters:
+

nexus_id – Thew new Nexus ID of this mod.

+
+
+
+ +
+
+setPluginSetting(plugin_name: str, key: str, value: MoVariant) → bool
+

Set the specified setting in this mod for a plugin.

+
+
Parameters:
+
    +

  • plugin_name – Name of the plugin for which to retrieve a setting. This should always be IPlugin.name() +unless you have a really good reason to access settings of another plugin.

    • +

  • key – Identifier of the setting.

    • +

  • value – New value for the setting to set.

    • +
+
+
Returns:
+

True if the setting was set correctly, False otherwise.

+
+
+
+ +
+
+setUrl(url: str) → None
+

Set the URL of this mod.

+
+
Parameters:
+

url – The URL of this mod.

+
+
+
+ +
+
+setVersion(version: VersionInfo) → None
+

Set the version of this mod.

+
+
Parameters:
+

version – The new version of this mod.

+
+
+
+ +
+
+trackedState() → TrackedState
+
+
Returns:
+

The tracked state of this mod.

+
+
+
+ +
+
+url() → str
+
+
Returns:
+

The URL of this mod, or an empty QString() if no URL is associated

+
+
+

with this mod.

+
+ +
+
+validated() → bool
+

Check if the mod was marked as validated by the user.

+

MO2 uses ModDataChecker to check the content of mods, but sometimes these fail, in +which case mods are incorrectly marked as ‘not containing valid games data’. Users can +choose to mark these mods as valid to hide the warning / flag.

+
+
Returns:
+

True if th is mod was marked as containing valid game data.

+
+
+
+ +
+
+version() → VersionInfo
+
+
Returns:
+

The current version of this mod.

+
+
+
+ +
+ +
+
+class mobase.IModList
+

Interface to the mod-list.

+

All api functions in this interface work need the internal name of a mod to find a +mod. For regular mods (mods the user installed) the display name (as shown to the user) +and internal name are identical. For other mods (non-MO mods) there is currently no way +to translate from display name to internal name because the display name might not me un-ambiguous.

+
+
+allMods() → Sequence[str]
+
+
Returns:
+

A list containing the internal names of all installed mods.

+
+
+
+ +
+
+allModsByProfilePriority(profile: IProfile | None = None) → Sequence[str]
+
+
Returns:
+

The list of mod (names), sorted according to the current profile priorities.

+
+
+
+ +
+
+displayName(name: str) → str
+

Retrieve the display name of a mod from its internal name.

+

If you received an internal name from the API (e.g. IPluginList.origin) then you should use +that name to identify the mod in all other api calls but use this function to retrieve the name +to show to the user.

+
+
Parameters:
+

name – Internal name of the mod.

+
+
Returns:
+

The display name of the given mod.

+
+
+
+ +
+
+getMod(name: str) → IModInterface
+

Retrieve an interface to a mod using its name.

+
+
Parameters:
+

name – Name of the mod to retrieve.

+
+
Returns:
+

An interface to the given mod, or None if there is no mod with this name.

+
+
+
+ +
+
+onModInstalled(callback: Callable[[IModInterface], None]) → bool
+

Install a new handler to be called when a new mod is installed.

+
+
Parameters:
+

callback – The function to call when a mod is installed. The parameter of the function is the name of the +newly installed mod.

+
+
Returns:
+

True if the handler was installed properly (there are currently no reasons for this to fail).

+
+
+
+ +
+
+onModMoved(callback: Callable[[str, int, int], None]) → bool
+

Install a handler to be called when a mod is moved.

+
+
Parameters:
+

callback – The function to call when a mod is moved. The first argument is the internal name of the +mod, the second argument the old priority and the third argument the new priority.

+
+
Returns:
+

True if the handler was installed properly (there are currently no reasons for this to fail).

+
+
+
+ +
+
+onModRemoved(callback: Callable[[str], None]) → bool
+

Install a new handler to be called when a mod is removed.

+
+
Parameters:
+

callback – The function to call when a mod is removed. The parameter of the function is the name of the +removed mod.

+
+
Returns:
+

True if the handler was installed properly (there are currently no reasons for this to fail).

+
+
+
+ +
+
+onModStateChanged(callback: Callable[[dict[str, ModState]], None]) → bool
+

Install a handler to be called when mod states change (enabled/disabled, endorsed, …).

+
+
Parameters:
+

callback – The function to call when the states of mod change. The argument is a map containing the +mods whose states have changed. Keys are internal mod names and values are mod states.

+
+
Returns:
+

True if the handler was installed properly (there are currently no reasons for this to fail).

+
+
+
+ +
+
+priority(name: str) → int
+

Retrieve the priority of a mod.

+
+
Parameters:
+

name – Internal name of the mod.

+
+
Returns:
+

The priority of the given mod.

+
+
+
+ +
+
+removeMod(mod: IModInterface) → bool
+

Remove a mod (from disc and from the UI).

+
+
Parameters:
+

mod – The mod to remove.

+
+
Returns:
+

True if the mod was removed, False otherwise.

+
+
+
+ +
+
+renameMod(mod: IModInterface, name: str) → IModInterface
+

Rename the given mod.

+

This method usually invalidates the given mod so you should use the returned value +after calling it instead of the passed value.

+
+
Parameters:
+
    +

  • mod – The mod to rename.

    • +

  • name – The new name of the mod.

    • +
+
+
Returns:
+

A valid reference to the given mod after renaming it.

+
+
+
+ +
+
+setActive(names: Sequence[str], active: bool) → int
+
+setActive(name: str, active: bool) → bool
+

Enable or disable a mod.

+

Calling this will cause MO to re-evaluate its virtual file system so this is +a fairly expensive call.

+
+
Parameters:
+
    +

  • name – Internal name of the mod to enable or disable.

    • +

  • active – True to enable the mod, False to disable it.

    • +
+
+
Returns:
+

True on success, False otherwise.

+
+
+
+ +
+
+setPriority(name: str, priority: int) → bool
+

Change the priority of a mod.

+

priority is the new priority after the move. Keep in mind that the mod disappears from its +old location and all mods with higher priority than the moved mod decrease in priority by one.

+
+
Parameters:
+
    +

  • name – Internal name of the mod.

    • +

  • priority – The new priority of the mod.

    • +
+
+
Returns:
+

True if the priority was changed, False otherwise (if the name or priority were invalid).

+
+
+
+ +
+
+state(name: str) → ModState
+

Retrieve the state of a mod.

+
+
Parameters:
+

name – Internal name of the mod.

+
+
Returns:
+

The state of the given mod.

+
+
+
+ +
+ +
+
+class mobase.IModRepositoryBridge
+

Bases: PyQt6.QtCore.QObject

+
+
+__getattr__(arg0: str) → object
+
+ +
+
+_object() → PyQt6.QtCore.QObject
+
+
Returns:
+

The underlying QObject for the bridge.

+
+
+
+ +
+
+requestDescription(game_name: str, mod_id: int, user_data: MoVariant) → None
+

Request description of a mod.

+
+
Parameters:
+
    +

  • game_name – Name of the game containing the mod.

    • +

  • mod_id – Nexus ID of the mod.

    • +

  • user_data – User data to be returned with the result.

    • +
+
+
+
+ +
+
+requestDownloadURL(game_name: str, mod_id: int, file_id: int, user_data: MoVariant) → None
+

Request download URL for mod file.0

+
+
Parameters:
+
    +

  • game_name – Name of the game containing the mod.

    • +

  • mod_id – Nexus ID of the mod.

    • +

  • file_id – ID of the file for which a URL should be returned.

    • +

  • user_data – User data to be returned with the result.

    • +
+
+
+
+ +
+
+requestFileInfo(game_name: str, mod_id: int, file_id: int, user_data: MoVariant) → None
+
+
Parameters:
+
    +

  • game_name – Name of the game containing the mod.

    • +

  • mod_id – Nexus ID of the mod.

    • +

  • file_id – ID of the file for which information is requested.

    • +

  • user_data – User data to be returned with the result.

    • +
+
+
+
+ +
+
+requestFiles(game_name: str, mod_id: int, user_data: MoVariant) → None
+

Request the list of files belonging to a mod.

+
+
Parameters:
+
    +

  • game_name – Name of the game containing the mod.

    • +

  • mod_id – Nexus ID of the mod.

    • +

  • user_data – User data to be returned with the result.

    • +
+
+
+
+ +
+
+requestToggleEndorsement(game_name: str, mod_id: int, mod_version: str, endorse: bool, user_data: MoVariant) → None
+
+
Parameters:
+
    +

  • game_name – Name of the game containing the mod.

    • +

  • mod_id – Nexus ID of the mod.

    • +

  • mod_version – Version of the mod.

    • +

  • endorse

    • +

  • user_data – User data to be returned with the result.

    • +
+
+
+
+ +
+
+descriptionAvailable: PyQt6.QtCore.pyqtSignal = Ellipsis
+
+ +
+
+downloadURLsAvailable: PyQt6.QtCore.pyqtSignal = Ellipsis
+
+ +
+
+endorsementToggled: PyQt6.QtCore.pyqtSignal = Ellipsis
+
+ +
+
+endorsementsAvailable: PyQt6.QtCore.pyqtSignal = Ellipsis
+
+ +
+
+fileInfoAvailable: PyQt6.QtCore.pyqtSignal = Ellipsis
+
+ +
+
+filesAvailable: PyQt6.QtCore.pyqtSignal = Ellipsis
+
+ +
+
+requestFailed: PyQt6.QtCore.pyqtSignal = Ellipsis
+
+ +
+
+trackedModsAvailable: PyQt6.QtCore.pyqtSignal = Ellipsis
+
+ +
+
+trackingToggled: PyQt6.QtCore.pyqtSignal = Ellipsis
+
+ +
+ +
+
+class mobase.IOrganizer
+

Interface to class that provides information about the running session +of Mod Organizer to be used by plugins.

+
+
+appVersion() → VersionInfo
+
+
Returns:
+

The running version of Mod Organizer.

+
+
+
+ +
+
+basePath() → str
+
+
Returns:
+

The absolute path to the base directory of Mod Organizer.

+
+
+
+ +
+
+createMod(name: GuessedString) → IModInterface
+

Create a new mod with the specified name.

+

If a mod with the same name already exists, the user will be queried. If the user chooses +to merge or replace, the call will succeed, otherwise the call will fail.

+
+
Parameters:
+

name – Name of the mod to create.

+
+
Returns:
+

An interface to the newly created mod that can be used to modify it, or None if the mod

+
+
+

could not be created.

+
+ +
+
+createNexusBridge() → IModRepositoryBridge
+

Create a new Nexus interface.

+
+
Returns:
+

The newly created Nexus interface.

+
+
+
+ +
+
+downloadManager() → IDownloadManager
+
+
Returns:
+

The interface to the download manager.

+
+
+
+ +
+
+downloadsPath() → str
+
+
Returns:
+

The absolute path to the download directory.

+
+
+
+ +
+
+findFileInfos(path: str | os.PathLike[str] | PyQt6.QtCore.QDir, filter: Callable[[FileInfo], bool]) → Sequence[FileInfo]
+

Find files in the virtual directory matching the specified filter.

+
+
Parameters:
+
    +

  • path – The path to search in (relative to the ‘data’ folder).

    • +

  • filter – The function to use to filter files. Should return True for the files to keep.

    • +
+
+
Returns:
+

The list of QFileInfo corresponding to the matching files.

+
+
+
+ +
+
+findFiles(path: str | os.PathLike[str] | PyQt6.QtCore.QDir, filter: Callable[[str], bool]) → Sequence[str]
+
+findFiles(path: str | os.PathLike[str] | PyQt6.QtCore.QDir, patterns: Sequence[str]) → Sequence[str]
+
+findFiles(path: str | os.PathLike[str] | PyQt6.QtCore.QDir, pattern: str) → Sequence[str]
+

Find files in the given folder that matches the given glob pattern.

+
+
Parameters:
+
    +

  • path – The path to search in (relative to the ‘data’ folder).

    • +

  • pattern – The glob pattern to use to filter files.

    • +
+
+
Returns:
+

The list of matching files.

+
+
+
+ +
+
+gameFeatures() → IGameFeatures
+
+
Returns:
+

The interface to the game features.

+
+
+
+ +
+
+getFileOrigins(filename: str) → Sequence[str]
+

Retrieve the file origins for the specified file.

+

The origins are listed with their internal name. The internal name of a mod can differ +from the display name for disambiguation.

+
+
Parameters:
+

filename – Path to the file to retrieve origins for (relative to the ‘data’ folder).

+
+
Returns:
+

The list of origins that contain the specified file, sorted by their priority.

+
+
+
+ +
+
+getGame(name: str) → IPluginGame
+

Retrieve the game plugin matching the given name.

+
+
Parameters:
+

name – Name of the game (short name).

+
+
Returns:
+

The plugin for the given game, or None if none was found.

+
+
+
+ +
+
+static getPluginDataPath() → str
+
+
Returns:
+

The directory for plugin data, typically plugins/data.

+
+
+
+ +
+
+installMod(filename: str | os.PathLike[str] | PyQt6.QtCore.QFileInfo, name_suggestion: str = '') → IModInterface
+

Install a mod archive at the specified location.

+
+
Parameters:
+
    +

  • filename – Absolute filepath to the archive to install.

    • +

  • name_suggestion – Suggested name for this mod. This can still be changed by the user.

    • +
+
+
Returns:
+

An interface to the new installed mod, or None if no installation took place (canceled or failure).

+
+
+
+ +
+
+isPluginEnabled(plugin: IPlugin) → bool
+
+isPluginEnabled(plugin: str) → bool
+

Check if a plugin is enabled.

+
+
Parameters:
+

plugin – The name of the plugin to check.

+
+
Returns:
+

True if the plugin is enabled, False otherwise.

+
+
+
+ +
+
+listDirectories(directory: str) → Sequence[str]
+

Retrieve the list of (virtual) subdirectories in the given path.

+
+
Parameters:
+

directory – Path to the directory to list (relative to the ‘data’ folder).

+
+
Returns:
+

The list of directories in the given directory.

+
+
+
+ +
+
+managedGame() → IPluginGame
+
+
Returns:
+

The plugin corresponding to the current game.

+
+
+
+ +
+
+modDataChanged(mod: IModInterface) → None
+

Notify the organizer that the given mod has changed.

+
+
Parameters:
+

mod – The mod that has changed.

+
+
+
+ +
+
+modList() → IModList
+
+
Returns:
+

The interface to the mod list.

+
+
+
+ +
+
+modsPath() → str
+
+
Returns:
+

The (absolute) path to the mods directory.

+
+
+
+ +
+
+onAboutToRun(callback: Callable[[str, PyQt6.QtCore.QDir, str], bool]) → bool
+
+onAboutToRun(callback: Callable[[str], bool]) → bool
+

Install a new handler to be called when an application is about to run.

+

Multiple handlers can be installed. If any of the handler returns False, the +application will not run.

+
+
Parameters:
+

callback – The function to call when an application is about to run. The parameter +is the absolute path to the application to run. The function can return False +to prevent the application from running.

+
+
Returns:
+

True if the handler was installed properly (there are currently no reasons for

+
+
+

this to fail).

+
+ +
+
+onFinishedRun(callback: Callable[[str, int], None]) → bool
+

Install a new handler to be called when an application has finished running.

+
+
Parameters:
+

callback – The function to call when an application has finished running. The first parameter is the absolute +path to the application, and the second parameter is the exit code of the application.

+
+
Returns:
+

True if the handler was installed properly (there are currently no reasons for

+
+
+

this to fail).

+
+ +
+
+onNextRefresh(callback: Callable[[], None], immediate_if_possible: bool = True) → bool
+

Install a new handler to be called on the next refresh or immediately.

+
+
Parameters:
+
    +

  • callback – Function to call on the next refresh (or immediately).

    • +

  • immediate_if_possible – If True, immediately run the callback if no refresh is currently running.

    • +
+
+
Returns:
+

True if the handler was installed properly (there are currently no reasons for

+
+
+

this to fail).

+
+ +
+
+onPluginDisabled(callback: Callable[[IPlugin], None]) → None
+
+onPluginDisabled(name: str, callback: Callable[[], None]) → None
+

Install a new handler to be called when the given plugin is disabled.

+
+
Parameters:
+
    +

  • name – Name of the plugin to watch.

    • +

  • callback – The function to call when the plugin is disabled.

    • +
+
+
+
+ +
+
+onPluginEnabled(callback: Callable[[IPlugin], None]) → None
+
+onPluginEnabled(name: str, callback: Callable[[], None]) → None
+

Install a new handler to be called when the given plugin is enabled.

+
+
Parameters:
+
    +

  • name – Name of the plugin to watch.

    • +

  • callback – The function to call when the plugin is enabled.

    • +
+
+
+
+ +
+
+onPluginSettingChanged(callback: Callable[[str, str, MoVariant, MoVariant], None]) → bool
+

Install a new handler to be called when a plugin setting is changed.

+
+
Parameters:
+

callback – The function to call when a plugin setting is changed. The parameters are: The name of the plugin, the +name of the setting, the old value (or None if the setting did not exist before) and the new value +of the setting (or None if the setting has been removed).

+
+
Returns:
+

True if the handler was installed properly (there are currently no reasons for this to fail).

+
+
+
+ +
+
+onProfileChanged(callback: Callable[[IProfile, IProfile], None]) → bool
+

Install a new handler to be called when the current profile is changed.

+

The function is called when the profile is changed but some operations related to +the profile might not be finished when this is called (e.g., the virtual file system +might not be up-to-date).

+
+
Parameters:
+

callback – The function to call when the current profile is changed. The first parameter is the old profile (can +be None, e.g. at startup), and the second parameter is the new profile (cannot be None).

+
+
Returns:
+

True if the handler was installed properly (there are currently no reasons for this to fail).

+
+
+
+ +
+
+onProfileCreated(callback: Callable[[IProfile], None]) → bool
+

Install a new handler to be called when a new profile is created.

+
+
Parameters:
+

callback – The function to call when a new profile is created. The parameter is the new profile (can be +a temporary object and should not be stored).

+
+
Returns:
+

True if the handler was installed properly (there are currently no reasons for this to fail).

+
+
+
+ +
+
+onProfileRemoved(callback: Callable[[str], None]) → bool
+

Install a new handler to be called when a profile is remove.

+

The callbacks are called after the profile has been removed so the profile is not accessible +anymore.

+
+
Parameters:
+

callback – The function to call when a profile is remove. The parameter is the name of the profile that was +removed.

+
+
Returns:
+

True if the handler was installed properly (there are currently no reasons for this to fail).

+
+
+
+ +
+
+onProfileRenamed(callback: Callable[[IProfile, str, str], None]) → bool
+

Install a new handler to be called when a profile is renamed.

+
+
Parameters:
+

callback – The function to call when a profile is renamed. The first parameter is the profile being renamed, +the second parameter the previous name and the third parameter the new name.

+
+
Returns:
+

True if the handler was installed properly (there are currently no reasons for this to fail).

+
+
+
+ +
+
+onUserInterfaceInitialized(callback: Callable[[PyQt6.QtWidgets.QMainWindow], None]) → bool
+

Install a new handler to be called when the UI has been fully initialized.

+
+
Parameters:
+

callback – The function to call when the user-interface has been fully initialized. The parameter is the main +window of the application (QMainWindow).

+
+
Returns:
+

True if the handler was installed properly (there are currently no reasons for this to fail).

+
+
+
+ +
+
+overwritePath() → str
+
+
Returns:
+

The (absolute) path to the overwrite directory.

+
+
+
+ +
+
+persistent(plugin_name: str, key: str, default: MoVariant = None) → MoVariant
+

Retrieve the specified persistent value for a plugin.

+

A persistent is an arbitrary value that the plugin can set and retrieve that is persistently stored +by the main application. There is no UI for the user to change this value but they can directly access +the storage

+
+
Parameters:
+
    +

  • plugin_name – Name of the plugin for which to retrieve the value. This should always be IPlugin.name() unless you have a +really good reason to access data of another mod AND if you can verify that plugin is actually installed.

    • +

  • key – Identifier of the setting.

    • +

  • default – Default value to return if the key is not set (yet).

    • +
+
+
Returns:
+

The value corresponding to the given persistent setting, or def is the key is not found.

+
+
+
+ +
+
+pluginDataPath() → str
+

Retrieve the path to a directory where plugin data should be stored.

+

For python plugins, it is recommended to use a dedicated folder (per plugin) if you need to +store data (resources, or multiple python files).

+
+
Returns:
+

Path to a directory where plugin data should be stored.

+
+
+
+ +
+
+pluginList() → IPluginList
+
+
Returns:
+

The plugin list interface.

+
+
+
+ +
+
+pluginSetting(plugin_name: str, key: str) → MoVariant
+

Retrieve settings of plugins.

+
+
Parameters:
+
    +

  • plugin_name – Name of the plugin to retrieve the setting for.

    • +

  • key – Name of the setting to retrieve the value for.

    • +
+
+
Returns:
+

The value of the setting.

+
+
+
+ +
+
+profile() → IProfile
+
+
Returns:
+

The interface to the current profile.

+
+
+
+ +
+
+profileName() → str
+
+
Returns:
+

The name of the current profile, or an empty string if no profile has been loaded (yet).

+
+
+
+ +
+
+profilePath() → str
+
+
Returns:
+

The absolute path to the active profile or an empty string if no profile has been loaded (yet).

+
+
+
+ +
+
+refresh(save_changes: bool = True) → None
+

Refresh the internal mods file structure from disk. This includes the mod list, the plugin +list, data tab and other smaller things like problems button (same as pressing F5).

+

The main part of the refresh of the mods file structure, mod list and plugin list is done +asynchronously, so you should not expect them to be up-to-date when this function returns.

+
+
Parameters:
+

save_changes – If True, the relevant profile information is saved first (enabled mods and order of mods).

+
+
+
+ +
+
+resolvePath(filename: str | os.PathLike[str] | PyQt6.QtCore.QFileInfo) → str
+

Resolves a path relative to the virtual data directory to its absolute real path.

+
+
Parameters:
+

filename – Path to resolve.

+
+
Returns:
+

The absolute real path, or an empty string if the path was not found.

+
+
+
+ +
+
+setPersistent(plugin_name: str, key: str, value: MoVariant, sync: bool = True) → None
+

Set the specified persistent value for a plugin.

+

This does not update the in-memory value for this setting, see setPluginSetting() for this.

+
+
Parameters:
+
    +

  • plugin_name – Name of the plugin for which to change a value. This should always be IPlugin.name() unless you have a +really good reason to access data of another mod AND if you can verify that plugin is actually installed.

    • +

  • key – Identifier of the setting.

    • +

  • value – New value for the setting.

    • +

  • sync – If True, the storage is immediately written to disc. This costs performance but is safer against data loss.

    • +
+
+
+
+ +
+
+setPluginSetting(plugin_name: str, key: str, value: MoVariant) → None
+

Set the specified setting for a plugin.

+

This automatically notify handlers register with onPluginSettingChanged, so you do not have to do it yourself.

+
+
Parameters:
+
    +

  • plugin_name – Name of the plugin for which to change a value. This should always be IPlugin.name() unless you have a +really good reason to access data of another mod AND if you can verify that plugin is actually installed.

    • +

  • key – Identifier of the setting.

    • +

  • value – New value for the setting.

    • +
+
+
+
+ +
+
+startApplication(executable: str | os.PathLike[str] | PyQt6.QtCore.QFileInfo, args: Sequence[str] = [], cwd: str | os.PathLike[str] | PyQt6.QtCore.QDir = '', profile: str = '', forcedCustomOverwrite: str = '', ignoreCustomOverwrite: bool = False) → int
+

Starts an application with virtual filesystem active.

+
+
Parameters:
+
    +

  • executable – Name or path of the executable. If this is only a filename, it will only work if it has been configured +in MO as an executable. If it is a relative path it is expected to be relative to the game directory.

    • +

  • args – Arguments to pass to the executable. If the list is empty, and executable refers to a configured executable, +the configured arguments are used.

    • +

  • cwd – The working directory for the executable. If this is empty, the path to the executable is used unless executable +referred to a configured MO executable, in which case the configured cwd is used.

    • +

  • profile – Profile to use. If this is empty (the default) the current profile is used.

    • +

  • forcedCustomOverwrite – The mod to set as the custom overwrite, regardless of what the profile has configured.

    • +

  • ignoreCustomOverwrite – Set to true to ignore the profile’s configured custom overwrite.

    • +
+
+
Returns:
+

The handle to the started application, or 0 if the application failed to start.

+
+
+
+ +
+
+virtualFileTree() → IFileTree
+

Retrieve a IFileTree object representing the virtual file tree.

+
+
Returns:
+

An IFileTree representing the virtual file tree.

+
+
+
+ +
+
+waitForApplication(handle: int, refresh: bool = True) → tuple[bool, int]
+

Wait for the application corresponding to the given handle to finish.

+

This will always show the lock overlay, regardless of whether the +user has disabled locking in the setting, so use this with care. +Note that the lock overlay will always allow the user to unlock, in +which case this will return False.

+
+
Parameters:
+
    +

  • handle – Handle of the application to wait for (as returned by startApplication()).

    • +

  • refresh – Whether ModOrganizer should refresh after the process completed or not.

    • +
+
+
Returns:
+

A tuple (result, exitcode), where result is a boolean indicating if the application

+
+
+

completed successfully, and exitcode is the exit code of the application.

+
+ +
+ +
+
+class mobase.IPlugin
+

Bases: abc.ABC

+

Base class for all plugins.

+
+
+abstract author() → str
+
+
Returns:
+

The name of the plugin author.

+
+
+
+ +
+
+abstract description() → str
+
+
Returns:
+

The description for this plugin.

+
+
+
+ +
+
+enabledByDefault() → bool
+

Check whether this plugin should be enabled by default.

+
+
Returns:
+

True if this plugin should be enabled by default, False otherwise.

+
+
+
+ +
+
+abstract init(organizer: IOrganizer) → bool
+

Initialize this plugin.

+

Note that this function may never be called if no IOrganizer is available +at that time, such as when creating the first instance in MO.

+

Plugins will probably want to store the organizer pointer. It is guaranteed +to be valid as long as the plugin is loaded.

+

These functions may be called before init():

+
+
    +

  • name()

    • +

  • see IPluginGame for more.

    • +
+
+
+
Parameters:
+

organizer – The main organizer interface.

+
+
Returns:
+

True if the plugin was initialized correctly, False otherwise.

+
+
+
+ +
+
+localizedName() → str
+

Retrieve the localized name of the plugin.

+

Unlike name(), this method can (and should!) return a localized name for the plugin. +This method returns name() by default.

+
+
Returns:
+

The localized name of the plugin.

+
+
+
+ +
+
+master() → str
+

Retrieve the master plugin of this plugin.

+

It is often easier to implement a functionality as multiple plugins in MO2, but ship the +plugins together, e.g. as a Python module or using createFunctions(). In this case, having +a master plugin (one of the plugin, or a separate one) tells MO2 that these plugins are +linked and should also be displayed together in the UI. If MO2 ever implements automatic +updates for plugins, the master() plugin will also be used for this purpose.

+
+
Returns:
+

The master plugin of this plugin, or a null pointer if this plugin does not have a master.

+
+
+
+ +
+
+abstract name() → str
+

Retrieve the name of the plugin.

+

The name of the plugin is used for internal storage purpose so it should not change, +and it should be static. In particular, you should not use a localized string (tr()) +for the plugin name.

+

In the future, we will provide a way to localized plugin names using a distinct method, +such as localizedName().

+
+
Returns:
+

The name of the plugin.

+
+
+
+ +
+
+requirements() → list[IPluginRequirement]
+

Retrieve the requirements for this plugin.

+

This method is called right after init() and the ownership the requirements is

+
+
Returns:
+

The list of requirements for this plugin.

+
+
+
+ +
+
+abstract settings() → Sequence[PluginSetting]
+
+
Returns:
+

A list of settings for this plugin.

+
+
+
+ +
+
+abstract version() → VersionInfo
+
+
Returns:
+

The version of this plugin.

+
+
+
+ +
+ +
+
+class mobase.IPluginDiagnose
+

Bases: IPlugin

+

Plugins that create problem reports to be displayed in the UI.

+

This can be used to report problems related to the same plugin (which implements further +interfaces) or as a stand-alone diagnosis tool.

+
+
+_invalidate() → None
+

Invalidate the problems corresponding to this plugin.

+
+ +
+
+abstract activeProblems() → list[int]
+

Retrieve the list of active problems found by this plugin.

+

This method returns a list of problem IDs, that are then used when calling other methods +such as shortDescription() or hasGuidedFix().

+
+
Returns:
+

The list of active problems for this plugin.

+
+
+
+ +
+
+abstract fullDescription(key: int) → str
+

Retrieve the full description of the problem corresponding to the given key.

+
+
Parameters:
+

key – ID of the problem.

+
+
Returns:
+

The full description of the problem.

+
+
Raises:
+

IndexError – If the key is not valid.

+
+
+
+ +
+
+abstract hasGuidedFix(key: int) → bool
+

Check if the problem corresponding to the given key has a guided fix.

+
+
Parameters:
+

key – ID of the problem.

+
+
Returns:
+

True if there is a guided fix for the problem, False otherwise.

+
+
Raises:
+

IndexError – If the key is not valid.

+
+
+
+ +
+
+abstract shortDescription(key: int) → str
+

Retrieve the short description of the problem corresponding to the given key.

+
+
Parameters:
+

key – ID of the problem.

+
+
Returns:
+

The short description of the problem.

+
+
Raises:
+

IndexError – If the key is not valid.

+
+
+
+ +
+
+abstract startGuidedFix(key: int) → None
+

Starts a guided fix for the problem corresponding to the given key.

+

This method should throw ValueError if there is no guided fix for the corresponding +problem.

+
+
Parameters:
+

key – ID of the problem.

+
+
Raises:
+
    +

  • IndexError – If the key is not valid.

    • +

  • ValueError – If there is no guided fix for this problem.

    • +
+
+
+
+ +
+ +
+
+class mobase.IPluginFileMapper
+

Bases: IPlugin

+

Plugins that adds virtual file links.

+
+
+abstract mappings() → list[Mapping]
+
+
Returns:
+

Mapping for the virtual file system (VFS).

+
+
+
+ +
+ +
+
+class mobase.IPluginGame
+

Bases: IPlugin

+

Base classes for game plugins.

+

Each game requires a specific game plugin. These plugins were initially designed for +Bethesda games, so a lot of methods and attributes are irrelevant for other games. If +you wish to write a plugin for a much simpler game, please consider the basic_games +plugin: https://github.com/ModOrganizer2/modorganizer-basic_games

+
+
+CCPlugins() → Sequence[str]
+
+
Returns:
+

The current list of active Creation Club plugins.

+
+
+
+ +
+
+DLCPlugins() → Sequence[str]
+
+
Returns:
+

The list of esp/esm files that are part of known DLCs.

+
+
+
+ +
+
+abstract binaryName() → str
+
+
Returns:
+

The name of the default executable to run (relative to the game folder).

+
+
+
+ +
+
+abstract dataDirectory() → PyQt6.QtCore.QDir
+
+
Returns:
+

The path to the directory containing data (absolute path).

+
+
+
+ +
+
+abstract detectGame() → None
+

Detect the game.

+

This method is the first called for game plugins (before init()). The following +methods should work properly after the call to detectGame() (and before init()):

+
+
    +

  • gameName()

    • +

  • isInstalled()

    • +

  • gameIcon()

    • +

  • gameDirectory()

    • +

  • dataDirectory()

    • +

  • gameVariants()

    • +

  • looksValid()

    • +
+
+

See IPlugin.init() for more.

+
+ +
+
+displayGameName() → str
+
+
Returns:
+

The name of the game to user for display, default to gameName().

+
+
+
+ +
+
+abstract documentsDirectory() → PyQt6.QtCore.QDir
+
+
Returns:
+

The directory of the documents folder where configuration files and such for this game reside.

+
+
+
+ +
+
+enabledPlugins() → Sequence[str]
+
+
Returns:
+

A list of plugins enabled by the game but not in a strict load order.

+
+
+
+ +
+
+abstract executableForcedLoads() → Sequence[ExecutableForcedLoadSetting]
+
+
Returns:
+

A list of automatically discovered libraries that can be force loaded with executables.

+
+
+
+ +
+
+executables() → Sequence[ExecutableInfo]
+
+
Returns:
+

A list of automatically discovered executables of the game itself and tools surrounding it.

+
+
+
+ +
+
+abstract gameDirectory() → PyQt6.QtCore.QDir
+
+
Returns:
+

The directory containing the game installation.

+
+
+
+ +
+
+abstract gameIcon() → PyQt6.QtGui.QIcon
+
+
Returns:
+

The icon representing the game.

+
+
+
+ +
+
+abstract gameName() → str
+
+
Returns:
+

The name of the game (for internal usage).

+
+
+
+ +
+
+gameNexusName() → str
+
+
Returns:
+

The name of the game identifier for Nexus.

+
+
+
+ +
+
+abstract gameShortName() → str
+
+
Returns:
+

The short name of the game.

+
+
+
+ +
+
+gameVariants() → Sequence[str]
+

Retrieve the list of variants for this game.

+

If there are multiple variants of a game (and the variants make a difference to the +plugin), like a regular one and a GOTY-edition, the plugin can return a list of them +and the user gets to chose which one he owns.

+
+
Returns:
+

The list of variants of the game.

+
+
+
+ +
+
+abstract gameVersion() → str
+
+
Returns:
+

The version of the game.

+
+
+
+ +
+
+abstract getLauncherName() → str
+
+
Returns:
+

The name of the launcher executable to run (relative to the game folder), or an

+
+
+

empty string if there is no launcher.

+
+ +
+
+abstract getSupportURL() → str
+
+
Returns:
+

An URL for the support page of this game.

+
+
+
+ +
+
+iniFiles() → Sequence[str]
+
+
Returns:
+

The list of INI files this game uses. The first file in the list should be the

+
+
+

‘main’ INI file.

+
+ +
+
+abstract initializeProfile(directory: PyQt6.QtCore.QDir, settings: ProfileSetting) → None
+

Initialize a profile for this game.

+

The MO app does not yet support virtualizing only specific aspects but plugins should be written +with this future functionality in mind.

+

This function will be used to initially create a profile, potentially to repair it or upgrade/downgrade +it so the implementations have to gracefully handle the case that the directory already contains files.

+
+
Parameters:
+
    +

  • directory – The directory where the profile is to be initialized.

    • +

  • settings – The parameters for how the profile should be initialized.

    • +
+
+
+
+ +
+
+abstract isInstalled() → bool
+
+
Returns:
+

True if this game has been discovered as installed, False otherwise.

+
+
+
+ +
+
+abstract listSaves(folder: PyQt6.QtCore.QDir) → list[ISaveGame]
+

List saves in the given directory.

+
+
Parameters:
+

folder – The folder to list saves from.

+
+
Returns:
+

The list of game saves in the given folder.

+
+
+
+ +
+
+loadOrderMechanism() → LoadOrderMechanism
+
+
Returns:
+

The load order mechanism used by this game.

+
+
+
+ +
+
+abstract looksValid(directory: PyQt6.QtCore.QDir) → bool
+

Check if the given directory looks like a valid game installation.

+
+
Parameters:
+

directory – Directory to check.

+
+
Returns:
+

True if the directory looks like a valid installation of this game, False otherwise.

+
+
+
+ +
+
+lootGameName() → str
+
+
Returns:
+

The game name to use when calling LOOT from MO2, default to gameShortName().

+
+
+
+ +
+
+abstract nexusGameID() → int
+

Retrieve the Nexus game ID for this game.

+

Example: For Skyrim, the Nexus game ID is 110.

+
+
Returns:
+

The Nexus game ID for this game.

+
+
+
+ +
+
+nexusModOrganizerID() → int
+

Retrieve the Nexus mod ID of Mod Organizer for this game.

+
+
Example: For Skyrim SE, the mod ID of MO2 is 6194. You can find the mod ID in the URL:

https://www.nexusmods.com/skyrimspecialedition/mods/6194

+
+
+
+
Returns:
+

The Nexus mod ID of Mod Organizer for this game.

+
+
+
+ +
+
+primaryPlugins() → Sequence[str]
+
+
Returns:
+

The list of plugins that are part of the game and not considered optional.

+
+
+
+ +
+
+primarySources() → Sequence[str]
+

Retrieve primary alternative ‘short’ names for this game.

+

This is used to determine if a Nexus (or other) download source should be considered +as a primary source for the game so that it is not flagged as an alternative one.

+
+
Returns:
+

The list of primary alternative ‘short’ names for this game, or an empty list.

+
+
+
+ +
+
+abstract savesDirectory() → PyQt6.QtCore.QDir
+
+
Returns:
+

The directory where save games are stored.

+
+
+
+ +
+
+secondaryDataDirectories() → Dict[str, PyQt6.QtCore.QDir]
+

Retrieve the list of secondary data directories. Each directories should be +assigned a unique name that differs from “data” which is the name of the main +data directory returned by dataDirectory().

+
+
Returns:
+

A mapping from unique name to secondary data directories.

+
+
+
+ +
+
+abstract setGamePath(path: str) → None
+

Set the path to the managed game.

+

This is called during instance creation if the game is not auto-detected and the user has +to specify the installation location. This is not called if the game has been auto-detected, +so isInstalled() should call this.

+
+
Parameters:
+

path – Path to the game installation.

+
+
+
+ +
+
+abstract setGameVariant(variant: str) → None
+

Set the game variant.

+

If there are multiple variants of game (as returned by gameVariants()), this will be +called on start with the user-selected game variant.

+
+
Parameters:
+

variant – The game variant selected by the user.

+
+
+
+ +
+
+sortMechanism() → SortMechanism
+
+
Returns:
+

The sort mechanism for this game.

+
+
+
+ +
+
+steamAPPId() → str
+

Retrieve the Steam app ID for this game.

+

If the game is not available on Steam, this should return an empty string.

+

If a game is available in multiple versions, those might have different app ids. The plugin +should try to return the right one

+
+
Returns:
+

The Steam app ID for this game. Should be empty for games not available on steam.

+
+
+
+ +
+
+abstract validShortNames() → Sequence[str]
+

Retrieve the valid ‘short’ names for this game.

+

This is used to determine if a Nexus download is valid for the current game since not all +game variants have their own nexus pages and others can handle downloads from other nexus +game pages and should be allowed to do so (e.g., you can install some Skyrim LE mod even +when using Skyrim SE).

+

The short name should be considered the primary handler for a directly supported game +for purposes of auto-launching an instance.

+
+
Returns:
+

The list of valid short names for this game.

+
+
+
+ +
+ +
+
+class mobase.IPluginInstaller
+

Bases: IPlugin

+

This is the top-level class for installer. Actual installers should inherit either:

+
+
    +

  • IPluginInstallerSimple if the installer can work directly with the archive. This is what +most installers use.

    • +

  • IPluginInstallerCustom if the installer needs to perform custom operations. This is only +used by the external NCC installer and the OMOD installer.

    • +
+
+
+
+_manager() → IInstallationManager
+
+
Returns:
+

The installation manager.

+
+
+
+ +
+
+_parentWidget() → PyQt6.QtWidgets.QWidget
+
+
Returns:
+

The parent widget.

+
+
+
+ +
+
+abstract isArchiveSupported(tree: IFileTree) → bool
+

Check if the given file tree corresponds to a supported archive for this installer.

+
+
Parameters:
+

tree – The tree representing the content of the archive.

+
+
Returns:
+

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

+
+
+
+ +
+
+abstract isManualInstaller() → bool
+

Check if this installer is a manual installer.

+
+
Returns:
+

True if this installer is a manual installer, False otherwise.

+
+
+
+ +
+
+onInstallationEnd(result: InstallResult, new_mod: IModInterface) → None
+

Method calls at the end of the installation process. This method is only called once +per installation process, even for recursive installations (e.g. with the bundle installer).

+
+
Parameters:
+
    +

  • result – The result of the installation.

    • +

  • new_mod – If the installation succeeded (result is RESULT_SUCCESS), contains the newly +installed mod, otherwise it contains a null pointer.

    • +
+
+
+
+ +
+
+onInstallationStart(archive: str, reinstallation: bool, current_mod: IModInterface) → None
+

Method calls at the start of the installation process, before any other methods. +This method is only called once per installation process, even for recursive +installations (e.g. with the bundle installer).

+

If reinstallation is true, then the given mod is the mod being reinstalled (the one +selected by the user). If reinstallation is false and currentMod is not null, then +it corresponds to a mod MO2 thinks corresponds to the archive (e.g. based on matching Nexus ID +or name).

+

The default implementation does nothing.

+
+
Parameters:
+
    +

  • archive – Path to the archive that is going to be installed.

    • +

  • reinstallation – True if this is a reinstallation, False otherwise.

    • +

  • current_mod – A currently installed mod corresponding to the archive being installed, or None +if there is no such mod.

    • +
+
+
+
+ +
+
+abstract priority() → int
+

Retrieve the priority of this installer.

+

If multiple installers are able to handle an archive, the one with the highest priority wins.

+
+
Returns:
+

The priority of this installer.

+
+
+
+ +
+
+setInstallationManager(manager: IInstallationManager) → None
+

Set the installation manager for this installer.

+

Python plugins usually do not need to re-implement this and can directly access the installation +manager using _manager().

+
+
Parameters:
+

manager – The installation manager.

+
+
+
+ +
+
+setParentWidget(parent: PyQt6.QtWidgets.QWidget) → None
+

Set the parent widget for this installer.

+

Python plugins usually do not need to re-implement this and can directly access the parent +widget using _parentWidget() once the UI has been initialized.

+
+
Parameters:
+

parent – The parent widget.

+
+
+
+ +
+ +
+
+class mobase.IPluginInstallerCustom
+

Bases: 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.

+
+
+abstract install(mod_name: GuessedString, game_name: str, archive_name: str, version: str, nexus_id: int) → InstallResult
+

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.

+
+
+
+ +
+
+abstract isArchiveSupported(tree: IFileTree) → bool
+
+abstract isArchiveSupported(archive_name: str) → bool
+

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.

+
+
+
+ +
+
+abstract supportedExtensions() → set[str]
+
+
Returns:
+

A list of file extensions that this installer can handle.

+
+
+
+ +
+ +
+
+class mobase.IPluginInstallerSimple
+

Bases: IPluginInstaller

+

Simple installer for mods. Simple installers only deal with an in-memory structure +representing the archive and can modify what to install and where by editing this structure. +Actually extracting the archive is handled by the manager.

+
+
+abstract install(name: GuessedString, tree: IFileTree, version: str, nexus_id: int) → InstallResult | IFileTree | tuple[InstallResult, IFileTree, str, int]
+

Install a mod from an archive filetree.

+

The installer can modify the given tree and use the manager to extract or create new +files.

+

This method returns different type of objects depending on the actual result of the +installation. The C++ bindings for this method always returns a tuple (result, tree, +version, id).

+
+
Parameters:
+
    +

  • 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).

    • +

  • tree – In-memory representation of the archive content.

    • +

  • version – Version of the mod, or an empty string is unknown.

    • +

  • nexus_id – ID of the mod, or -1 if unknown.

    • +
+
+
Returns:
+

In case of failure, the result of the installation, otherwise the modified tree or

+
+
+

a tuple (result, tree, version, id) containing the result of the installation, the +modified tree, the new version and the new ID. The tuple can be returned even if the +installation did not succeed.

+
+ +
+ +
+
+class mobase.IPluginList
+

Primary interface to the list of plugins.

+
+
+hasLightExtension(name: str) → bool
+

Determine if a plugin has a .esl extension.

+
+
Parameters:
+

name – Filename of the plugin (without path but with file extension).

+
+
Returns:
+

True if the given file has a .esl extension, False otherwise or if the

+
+
+

file does not exist.

+
+ +
+
+hasMasterExtension(name: str) → bool
+

Determine if a plugin has a .esm extension.

+
+
Parameters:
+

name – Filename of the plugin (without path but with file extension).

+
+
Returns:
+

True if the given file has a .esm extension, False otherwise or if the

+
+
+

file does not exist.

+
+ +
+
+hasNoRecords(name: str) → bool
+

Determine if a plugin has no records.

+
+
Parameters:
+

name – Filename of the plugin (without path but with file extension).

+
+
Returns:
+

True if the given file plugin contains no records, False if it does OR if the

+
+
+

file does not exist.

+
+ +
+
+isLightFlagged(name: str) → bool
+

Determine if a plugin is flagged as light.

+

In gamebryo games, a master file will usually have a .esl file extension but +technically an esp can be flagged as light.

+
+
Parameters:
+

name – Filename of the plugin (without path but with file extension).

+
+
Returns:
+

True if the given plugin is a light plugin, False otherwise or if the

+
+
+

file does not exist.

+
+ +
+
+isMasterFlagged(name: str) → bool
+

Determine if a plugin is flagged as mater, i.e., a library, reference by +other plugins.

+

In gamebryo games, a master file will usually have a .esm file extension but +technically an esp can be flagged as master and an esm might not be.

+
+
Parameters:
+

name – Filename of the plugin (without path but with file extension).

+
+
Returns:
+

True if the given plugin is a master plugin, False otherwise or if the

+
+
+

file does not exist.

+
+ +
+
+isMediumFlagged(name: str) → bool
+

Determine if a plugin is flagged as medium.

+

This plugin flag was added in Starfield and signifies plugin records that +update existing records

+
+
Parameters:
+

name – Filename of the plugin (without path but with file extension).

+
+
Returns:
+

True if the given plugin is a medium plugin, False otherwise or if the

+
+
+

file does not exist.

+
+ +
+
+loadOrder(name: str) → int
+

Retrieve the load order of a plugin.

+
+
Parameters:
+

name – Filename of the plugin (without path but with file extension).

+
+
Returns:
+

The load order of the plugin (the order in which the game loads it). If all plugins are enabled this

+
+
+

is the same as the priority but disabled plugins will have a load order of -1. This also returns -1 +if the plugin does not exist.

+
+ +
+
+masters(name: str) → Sequence[str]
+

Retrieve the list of masters required for a plugin.

+
+
Parameters:
+

name – Filename of the plugin (without path but with file extension).

+
+
Returns:
+

The list of masters for the plugin (filenames with extension, no path).

+
+
+
+ +
+
+onPluginMoved(callback: Callable[[str, int, int], None]) → bool
+

Install a new handler to be called when a plugin is moved.

+
+
Parameters:
+

callback – The function to call when a plugin is moved. The first parameter is the plugin name, the +second the old priority of the plugin and the third one the new priority.

+
+
Returns:
+

True if the handler was installed properly (there are currently no reasons for this to fail).

+
+
+
+ +
+
+onPluginStateChanged(callback: Callable[[dict[str, PluginState]], None]) → bool
+

Install a new handler to be called when plugin states change.

+
+
Parameters:
+

callback – The function to call when a plugin states change. The parameter is a map from plugin names to new +plugin states for the plugin whose states have changed.

+
+
Returns:
+

True if the handler was installed properly (there are currently no reasons for this to fail).

+
+
+
+ +
+
+onRefreshed(callback: Callable[[], None]) → bool
+

Install a new handler to be called when the list of plugins is refreshed.

+
+
Parameters:
+

callback – The function to call when the list of plugins is refreshed.

+
+
Returns:
+

True if the handler was installed properly (there are currently no reasons for this to fail).

+
+
+
+ +
+
+origin(name: str) → str
+

Retrieve the origin of a plugin. This is either the (internal) name of a mod, “overwrite” or “data”.

+

The internal name of a mod can differ from the display name for disambiguation.

+
+
Parameters:
+

name – Filename of the plugin (without path but with file extension).

+
+
Returns:
+

The name of the origin of the plugin, or an empty string if the plugin does not exist.

+
+
+
+ +
+
+pluginNames() → Sequence[str]
+
+
Returns:
+

The list of all plugin names.

+
+
+
+ +
+
+priority(name: str) → int
+

Retrieve the priority of a plugin.

+

The higher the priority, the more important.

+
+
Parameters:
+

name – Filename of the plugin (without path but with file extension).

+
+
Returns:
+

The priority of the given plugin, or -1 if the plugin does not exist.

+
+
+
+ +
+
+setLoadOrder(loadorder: Sequence[str]) → None
+

Set the load order.

+

Plugins not included in the list will be placed at highest priority in the order they +were before.

+
+
Parameters:
+

loadorder – The new load order, specified by the list of plugin names, sorted.

+
+
+
+ +
+
+setPriority(name: str, priority: int) → bool
+

Change the priority of a plugin.

+
+
Parameters:
+
    +

  • name – Filename of the plugin (without path but with file extension).

    • +

  • priority – New priority of the plugin.

    • +
+
+
Returns:
+

True on success, False if the priority change was not possible. This is usually because

+
+
+

one of the parameters is invalid. The function returns true even if the plugin was not moved +at the specified priority (e.g. when trying to move a non-master plugin before a master one).

+
+ +
+
+setState(name: str, state: PluginState) → None
+

Set the state of a plugin.

+
+
Parameters:
+
    +

  • name – Filename of the plugin (without path but with file extension).

    • +

  • state – New state of the plugin (INACTIVE or ACTIVE).

    • +
+
+
+
+ +
+
+state(name: str) → PluginState
+

Retrieve the state of a plugin.

+
+
Parameters:
+

name – Filename of the plugin (without path but with file extension).

+
+
Returns:
+

The state of the plugin.

+
+
+
+ +
+ +
+
+class mobase.IPluginModPage
+

Bases: IPlugin

+

Base class for all plugins.

+
+
+_parentWidget() → PyQt6.QtWidgets.QWidget
+
+
Returns:
+

The parent widget.

+
+
+
+ +
+
+abstract displayName() → str
+
+
Returns:
+

The name of the page as displayed in the UI.

+
+
+
+ +
+
+abstract handlesDownload(page_url: PyQt6.QtCore.QUrl, download_url: PyQt6.QtCore.QUrl, fileinfo: ModRepositoryFileInfo) → bool
+

Check if the plugin handles the specified download.

+
+
Parameters:
+
    +

  • page_url – URL of the page that contains the download link.

    • +

  • download_url – The download URL.

    • +

  • fileinfo – Not usable in python.

    • +
+
+
Returns:
+

True if this plugin wants to handle the specified download, False otherwise.

+
+
+
+ +
+
+abstract icon() → PyQt6.QtGui.QIcon
+
+
Returns:
+

The icon to display with the page.

+
+
+
+ +
+
+abstract pageURL() → PyQt6.QtCore.QUrl
+
+
Returns:
+

The URL to open when the user wants to visit this mod page.

+
+
+
+ +
+
+setParentWidget(parent: PyQt6.QtWidgets.QWidget) → None
+

Set the parent widget for this mod page.

+

Python plugins usually do not need to re-implement this and can directly access the parent +widget using _parentWidget() once the UI has been initialized.

+
+
Parameters:
+

parent – The parent widget.

+
+
+
+ +
+
+abstract useIntegratedBrowser() → bool
+

Indicates if the page should be displayed in the integrated browser.

+

Unless the page provides a special means of starting downloads (like the nxm:// url schema +on nexus), it will not be possible to handle downloads unless the integrated browser is used!

+
+
Returns:
+

True if the page should be opened in the integrated browser, False otherwise.

+
+
+
+ +
+ +
+
+class mobase.IPluginPreview
+

Bases: IPlugin

+

These plugins add support for previewing files in the data pane. Right now all image formats supported +by qt are implemented (including dds) but no audio files and no 3d mesh formats.

+
+
+abstract genDataPreview(file_data: PyQt6.QtCore.QByteArray, filename: str, max_size: PyQt6.QtCore.QSize) → PyQt6.QtWidgets.QWidget
+

Generate a preview widget from in-memory data.

+
+
Parameters:
+
    +

  • file_data – In-memory data to preview.

    • +

  • filename – Name of the file the data comes from.

    • +

  • max_size – Maximum size of the generated widget.

    • +
+
+
Returns:
+

The widget showing a preview of the in-memory data.

+
+
+
+ +
+
+abstract genFilePreview(filename: str, max_size: PyQt6.QtCore.QSize) → PyQt6.QtWidgets.QWidget
+

Generate a preview widget for the specified file.

+
+
Parameters:
+
    +

  • filename – Path to the file to preview.

    • +

  • max_size – Maximum size of the generated widget.

    • +
+
+
Returns:
+

The widget showing a preview of the file.

+
+
+
+ +
+
+abstract supportedExtensions() → set[str]
+
+
Returns:
+

The list of file extensions that are supported by this preview plugin.

+
+
+
+ +
+
+abstract supportsArchives() → bool
+

Check if this preview plugin supports preview from in-memory data.

+
+
Returns:
+

True if the plugin supports preview from raw data, False otherwise.

+
+
+
+ +
+ +
+
+class mobase.IPluginRequirement
+

Class representing requirements for plugins.

+
+
+class Problem(short_description: str, long_description: str = '')
+

Class representing a problem found by a requirement.

+
+
+longDescription() → str
+
+
Returns:
+

A long description of the problem.

+
+
+
+ +
+
+shortDescription() → str
+
+
Returns:
+

A short description of the problem.

+
+
+
+ +
+ +
+
+check(organizer: IOrganizer) → IPluginRequirement | None
+

Check if the requirement is met, and return a problem if not.

+
+
Parameters:
+

organizer – The IOrganizer instance.

+
+
Returns:
+

The problem found if the requirement is not met, otherwise None.

+
+
+
+ +
+ +
+
+class mobase.IPluginTool
+

Bases: IPlugin

+

This is the simplest of plugin interfaces. Such plugins simply place an icon inside the tools sub-menu +and get invoked when the user clicks it. They are expected to have a user interface of some sort. These +are almost like independent applications except they can access all Mod Organizer interfaces like querying +and modifying the current profile, mod list, load order, use MO to install mods and so on. A tool plugin +can (and should!) integrate its UI as a window inside MO and thus doesn’t have to initialize a windows +application itself.

+
+
+_parentWidget() → PyQt6.QtWidgets.QWidget
+
+
Returns:
+

The parent widget.

+
+
+
+ +
+
+abstract display() → None
+

Called when the user starts the tool.

+
+ +
+
+abstract displayName() → str
+
+
Returns:
+

The display name for this tool, as shown in the tool menu.

+
+
+
+ +
+
+abstract icon() → PyQt6.QtGui.QIcon
+
+
Returns:
+

The icon for this tool, or a default-constructed QICon().

+
+
+
+ +
+
+setParentWidget(parent: PyQt6.QtWidgets.QWidget) → None
+

Set the parent widget for this tool.

+

Python plugins usually do not need to re-implement this and can directly access the parent +widget using _parentWidget() once the UI has been initialized.

+
+
Parameters:
+

parent – The parent widget.

+
+
+
+ +
+
+abstract tooltip() → str
+
+
Returns:
+

The tooltip for this tool.

+
+
+
+ +
+ +
+
+class mobase.IProfile
+

Interface to interact with Mod Organizer 2 profiles.

+
+
+absoluteIniFilePath(inifile: str) → str
+

Retrieve the absolute file path to the corresponding INI file for this profile.

+

If iniFile does not correspond to a file in the list of INI files for the +current game (as returned by IPluginGame::iniFiles), the path to the global +file will be returned (if iniFile is absolute, iniFile is returned, otherwise +the path is assumed relative to the game documents directory).

+
+
Parameters:
+

inifile – INI file to retrieve a path for. This can either be the name of a file or a path to the +absolute file outside of the profile.

+
+
Returns:
+

The absolute path for the given INI file for this profile.

+
+
+
+ +
+
+absolutePath() → str
+
+
Returns:
+

The absolute path to the profile folder.

+
+
+
+ +
+
+invalidationActive() → tuple[bool, bool]
+
+
Returns:
+

True if automatic archive invalidation is enabled for this profile, False otherwise.

+
+
+
+ +
+
+localSavesEnabled() → bool
+
+
Returns:
+

True if profile-specific saves are enabled for this profile, False otherwise.

+
+
+
+ +
+
+localSettingsEnabled() → bool
+
+
Returns:
+

True if profile-specific game settings are enabled for this profile, False otherwise.

+
+
+
+ +
+
+name() → str
+
+
Returns:
+

The name of this profile.

+
+
+
+ +
+ +
+
+class mobase.ISaveGame
+

Base class for information about what is in a save game.

+
+
+allFiles() → Sequence[str | os.PathLike[str] | PyQt6.QtCore.QFileInfo]
+
+
Returns:
+

The list of all files related to this save.

+
+
+
+ +
+
+getCreationTime() → PyQt6.QtCore.QDateTime
+

Retrieve the creation time of the save.

+

The creation time of a save is not always the same as the creation time of +the file containing the save.

+
+
Returns:
+

The creation time of the save.

+
+
+
+ +
+
+getFilepath() → str | os.PathLike[str] | PyQt6.QtCore.QFileInfo
+
+
Returns:
+

The path name to the (main) file or folder for the save.

+
+
+
+ +
+
+getName() → str
+
+
Returns:
+

The name of this save, for display purpose.

+
+
+
+ +
+
+getSaveGroupIdentifier() → str
+

Retrieve the name of the group this files belong to.

+

The name can be used to identify sets of saves to transfer between profiles. For +RPG games, this is usually the name of a character.

+
+
Returns:
+

The group identifier for this save game.

+
+
+
+ +
+ +
+
+class mobase.ISaveGameInfoWidget(parent: PyQt6.QtWidgets.QWidget | None = None)
+

Bases: PyQt6.QtWidgets.QWidget

+

Base class for a save game info widget.

+
+
+__getattr__(arg0: str) → object
+
+ +
+
+_widget() → PyQt6.QtWidgets.QWidget
+
+
Returns:
+

The underlying QWidget.

+
+
+
+ +
+
+abstract setSave(save: ISaveGame) → None
+

Set the save file to display in this widget.

+
+
Parameters:
+

save – The save to display in the widget

+
+
+
+ +
+ +
+
+class mobase.InstallResult(*args, **kwds)
+

Bases: enum.Enum

+

Create a collection of name/value pairs.

+

Example enumeration:

+
>>> class Color(Enum):
+...     RED = 1
+...     BLUE = 2
+...     GREEN = 3
+
+
+

Access them by:

+
    +

  • attribute access:

    +
    >>> Color.RED
+<Color.RED: 1>
+
    +
    +
    • +

  • value lookup:

    +
    >>> Color(1)
+<Color.RED: 1>
+
    +
    +
    • +

  • name lookup:

    +
    >>> Color['RED']
+<Color.RED: 1>
+
    +
    +
    • +
+

Enumerations can be iterated over, and know how many members they have:

+
>>> len(Color)
+3
+
+
+
>>> list(Color)
+[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]
+
+
+

Methods can be added to enumerations, and members can have their own +attributes – see the documentation for details.

+
+
+__eq__(other: object) → bool
+

Return self==value.

+
+ +
+
+__int__() → int
+
+ +
+
+__ne__(other: object) → bool
+

Return self!=value.

+
+ +
+
+__str__() → str
+

Return str(self).

+
+ +
+
+CANCELED = Ellipsis
+
+ +
+
+FAILED = Ellipsis
+
+ +
+
+MANUAL_REQUESTED = Ellipsis
+
+ +
+
+NOT_ATTEMPTED = Ellipsis
+
+ +
+
+SUCCESS = Ellipsis
+
+ +
+
+property name: str
+

The name of the Enum member.

+
+ +
+
+property value: int
+

The value of the Enum member.

+
+ +
+ +
+
+class mobase.LoadOrderMechanism(*args, **kwds)
+

Bases: enum.Enum

+

Create a collection of name/value pairs.

+

Example enumeration:

+
>>> class Color(Enum):
+...     RED = 1
+...     BLUE = 2
+...     GREEN = 3
+
+
+

Access them by:

+
    +

  • attribute access:

    +
    >>> Color.RED
+<Color.RED: 1>
+
    +
    +
    • +

  • value lookup:

    +
    >>> Color(1)
+<Color.RED: 1>
+
    +
    +
    • +

  • name lookup:

    +
    >>> Color['RED']
+<Color.RED: 1>
+
    +
    +
    • +
+

Enumerations can be iterated over, and know how many members they have:

+
>>> len(Color)
+3
+
+
+
>>> list(Color)
+[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]
+
+
+

Methods can be added to enumerations, and members can have their own +attributes – see the documentation for details.

+
+
+__eq__(other: object) → bool
+

Return self==value.

+
+ +
+
+__int__() → int
+
+ +
+
+__ne__(other: object) → bool
+

Return self!=value.

+
+ +
+
+__str__() → str
+

Return str(self).

+
+ +
+
+FILE_TIME = Ellipsis
+
+ +
+
+NONE = Ellipsis
+
+ +
+
+PLUGINS_TXT = Ellipsis
+
+ +
+
+property name: str
+

The name of the Enum member.

+
+ +
+
+property value: int
+

The value of the Enum member.

+
+ +
+ +
+
+class mobase.LocalSavegames
+

Bases: GameFeature

+

Base class for all game features, cannot be inherited, used only for typing +purpose in Python.

+
+
+abstract mappings(profile_save_dir: PyQt6.QtCore.QDir) → list[Mapping]
+
+ +
+
+abstract prepareProfile(profile: IProfile) → bool
+
+ +
+ +
+
+class mobase.Mapping
+
+class mobase.Mapping(source: str, destination: str, is_directory: bool, create_target: bool = False)
+
+
+__str__() → str
+

Return str(self).

+
+ +
+
+property createTarget: bool
+
+ +
+
+property destination: str
+
+ +
+
+property isDirectory: bool
+
+ +
+
+property source: str
+
+ +
+ +
+
+class mobase.ModDataChecker
+

Bases: GameFeature

+

Game feature that is used to check the content of a data tree.

+
+
+class CheckReturn(*args, **kwds)
+

Bases: enum.Enum

+

Create a collection of name/value pairs.

+

Example enumeration:

+
>>> class Color(Enum):
+...     RED = 1
+...     BLUE = 2
+...     GREEN = 3
+
+
+

Access them by:

+
    +

  • attribute access:

    +
    >>> Color.RED
+<Color.RED: 1>
+
    +
    +
    • +

  • value lookup:

    +
    >>> Color(1)
+<Color.RED: 1>
+
    +
    +
    • +

  • name lookup:

    +
    >>> Color['RED']
+<Color.RED: 1>
+
    +
    +
    • +
+

Enumerations can be iterated over, and know how many members they have:

+
>>> len(Color)
+3
+
+
+
>>> list(Color)
+[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]
+
+
+

Methods can be added to enumerations, and members can have their own +attributes – see the documentation for details.

+
+
+__eq__(other: object) → bool
+

Return self==value.

+
+ +
+
+__int__() → int
+
+ +
+
+__ne__(other: object) → bool
+

Return self!=value.

+
+ +
+
+__str__() → str
+

Return str(self).

+
+ +
+
+FIXABLE = Ellipsis
+
+ +
+
+INVALID = Ellipsis
+
+ +
+
+VALID = Ellipsis
+
+ +
+
+property name: str
+

The name of the Enum member.

+
+ +
+
+property value: int
+

The value of the Enum member.

+
+ +
+ +
+
+abstract dataLooksValid(filetree: IFileTree) → ModDataChecker
+

Check that the given filetree represent a valid mod layout, or can be easily +fixed.

+

This method is mainly used during installation (to find which installer should +be used or to recurse into multi-level archives), or to quickly indicates to a +user if a mod looks valid.

+

This method does not have to be exact, it only has to indicate if the given tree +looks like a valid mod or not by quickly checking the structure (heavy operations +should be avoided).

+

If the tree can be fixed by the fix() method, this method should return FIXABLE. +FIXABLE should only be returned when it is guaranteed that fix() can fix the tree.

+
+
Parameters:
+

filetree – The tree starting at the root of the “data” folder.

+
+
Returns:
+

Whether the tree is invalid, fixable or valid.

+
+
+
+ +
+
+fix(filetree: IFileTree) → IFileTree | None
+

Try to fix the given tree.

+

This method is used during installation to try to fix invalid archives and will only be +called if dataLooksValid returned FIXABLE.

+
+
Parameters:
+

filetree – The tree to try to fix. Can be modified during the process.

+
+
Returns:
+

The fixed tree, or a null pointer if the tree could not be fixed.

+
+
+
+ +
+
+FIXABLE: ModDataChecker.CheckReturn = Ellipsis
+
+ +
+
+INVALID: ModDataChecker.CheckReturn = Ellipsis
+
+ +
+
+VALID: ModDataChecker.CheckReturn = Ellipsis
+
+ +
+ +
+
+class mobase.ModDataContent
+

Bases: GameFeature

+

The ModDataContent feature is used (when available) to indicate to users the content +of mods in the “Content” column.

+

The feature exposes a list of possible content types, each associated with an ID, a name +and an icon. The icon is the path to either:

+
+
    +

  • A Qt resource or;

    • +

  • A file on the disk.

    • +
+
+

In order to facilitate the implementation, MO2 already provides a set of icons that can +be used. Those icons are all under :/MO/gui/content (e.g. :/MO/gui/content/plugin or :/MO/gui/content/music `).

+

The list of available icons is:

+
+
    +

  • plugin: plugin-icon

    • +

  • skyproc: skyproc-icon

    • +

  • texture: texture-icon

    • +

  • music: music-icon

    • +

  • sound: sound-icon

    • +

  • interface: interface-icon

    • +

  • skse: skse-icon

    • +

  • script: script-icon

    • +

  • mesh: mesh-icon

    • +

  • string: string-icon

    • +

  • bsa: bsa-icon

    • +

  • menu: menu-icon

    • +

  • inifile: inifile-icon

    • +

  • modgroup: modgroup-icon

    • +
+
+
+
+class Content(id: int, name: str, icon: str, filter_only: bool = False)
+
+
+isOnlyForFilter() → bool
+
+
Returns:
+

True if this content is only meant to be used as a filter criteria.

+
+
+
+ +
+
+property icon: str
+
+ +
+
+property id: int
+
+ +
+
+property name: str
+
+ +
+ +
+
+abstract getAllContents() → list[ModDataContent]
+
+
Returns:
+

The list of all possible contents for the corresponding game.

+
+
+
+ +
+
+abstract getContentsFor(filetree: IFileTree) → list[int]
+

Retrieve the list of contents in the given tree.

+
+
Parameters:
+

filetree – The tree corresponding to the mod to retrieve contents for.

+
+
Returns:
+

The IDs of the content in the given tree.

+
+
+
+ +
+ +
+
+class mobase.ModRepositoryFileInfo(other: ModRepositoryFileInfo)
+
+class mobase.ModRepositoryFileInfo(game_name: str = '', mod_id: int = 0, file_id: int = 0)
+
+
+__str__() → str
+

Return str(self).

+
+ +
+
+static createFromJson(data: str) → ModRepositoryFileInfo
+
+ +
+
+property categoryID: int
+
+ +
+
+property description: str
+
+ +
+
+property fileCategory: int
+
+ +
+
+property fileID: int
+
+ +
+
+property fileName: str
+
+ +
+
+property fileSize: int
+
+ +
+
+property fileTime: PyQt6.QtCore.QDateTime
+
+ +
+
+property gameName: str
+
+ +
+
+property modID: int
+
+ +
+
+property modName: str
+
+ +
+
+property name: str
+
+ +
+
+property newestVersion: VersionInfo
+
+ +
+
+property repository: str
+
+ +
+
+property uri: str
+
+ +
+
+property userData: MoVariant
+
+ +
+
+property version: VersionInfo
+
+ +
+ +
+
+class mobase.ModState(*args, **kwds)
+

Bases: enum.Enum

+

Create a collection of name/value pairs.

+

Example enumeration:

+
>>> class Color(Enum):
+...     RED = 1
+...     BLUE = 2
+...     GREEN = 3
+
+
+

Access them by:

+
    +

  • attribute access:

    +
    >>> Color.RED
+<Color.RED: 1>
+
    +
    +
    • +

  • value lookup:

    +
    >>> Color(1)
+<Color.RED: 1>
+
    +
    +
    • +

  • name lookup:

    +
    >>> Color['RED']
+<Color.RED: 1>
+
    +
    +
    • +
+

Enumerations can be iterated over, and know how many members they have:

+
>>> len(Color)
+3
+
+
+
>>> list(Color)
+[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]
+
+
+

Methods can be added to enumerations, and members can have their own +attributes – see the documentation for details.

+
+
+__and__(other: ModState) → ModState
+
+ +
+
+__eq__(other: object) → bool
+

Return self==value.

+
+ +
+
+__ge__(other: ModState) → bool
+

Return self>=value.

+
+ +
+
+__gt__(other: ModState) → bool
+

Return self>value.

+
+ +
+
+__int__() → int
+
+ +
+
+__invert__() → ModState
+
+ +
+
+__le__(other: ModState) → bool
+

Return self<=value.

+
+ +
+
+__lt__(other: ModState) → bool
+

Return self<value.

+
+ +
+
+__ne__(other: object) → bool
+

Return self!=value.

+
+ +
+
+__or__(other: ModState) → ModState
+
+ +
+
+__rand__(other: ModState) → ModState
+
+ +
+
+__ror__(other: ModState) → ModState
+
+ +
+
+__rxor__(other: ModState) → ModState
+
+ +
+
+__str__() → str
+

Return str(self).

+
+ +
+
+__xor__(other: ModState) → ModState
+
+ +
+
+ACTIVE = Ellipsis
+
+ +
+
+ALTERNATE = Ellipsis
+
+ +
+
+EMPTY = Ellipsis
+
+ +
+
+ENDORSED = Ellipsis
+
+ +
+
+ESSENTIAL = Ellipsis
+
+ +
+
+EXISTS = Ellipsis
+
+ +
+
+VALID = Ellipsis
+
+ +
+
+property name: str
+

The name of the Enum member.

+
+ +
+
+property value: int
+

The value of the Enum member.

+
+ +
+ +
+
+class mobase.PluginRequirementFactory
+
+
+static basic(checker: Callable[[IOrganizer], bool], description: str) → IPluginRequirement
+

Create a basic requirement.

+
+
Parameters:
+
    +

  • checker – The callable to use to check if the requirement is met. Should return True +if the requirement is met, False otherwise.

    • +

  • description – The description of the problem, when the requirement is not met.

    • +
+
+
Returns:
+

The constructed requirement.

+
+
+
+ +
+
+static diagnose(diagnose: IPluginDiagnose) → IPluginRequirement
+

Construct a requirement from a diagnose plugin.

+

If the wrapped diagnose plugin reports a problem, the requirement fails +and the associated message is the one from the diagnose plugin (or the +list of messages if multiple problems were reported).

+
+
Parameters:
+

diagnose – The diagnose plugin to wrap in this requirement.

+
+
Returns:
+

The constructed requirement.

+
+
+
+ +
+
+static gameDependency(games: Sequence[str]) → IPluginRequirement
+
+static gameDependency(game: str) → IPluginRequirement
+

Create a new game dependency requirement.

+

The requirement is met when the managed game is the specified game.

+
+
Parameters:
+

game – The name of the required game.

+
+
Returns:
+

The constructed requirement.

+
+
+
+ +
+
+static pluginDependency(plugins: Sequence[str]) → IPluginRequirement
+
+static pluginDependency(plugin: str) → IPluginRequirement
+

Create a new plugin dependency requirement.

+

The requirement is met when the specified plugin is enabled.

+
+
Parameters:
+

plugin – The name of the plugin that must be enabled.

+
+
Returns:
+

The constructed requirement.

+
+
+
+ +
+ +
+
+class mobase.PluginSetting(key: str, description: str, default_value: MoVariant)
+

Class to hold the user-configurable parameters a plugin accepts. The purpose of this class is +only to inform the application what settings to offer to the user, it does not hold the actual value.

+
+
+property default_value: MoVariant
+
+ +
+
+property description: str
+
+ +
+
+property key: str
+
+ +
+ +
+
+class mobase.PluginState(*args, **kwds)
+

Bases: enum.Enum

+

Create a collection of name/value pairs.

+

Example enumeration:

+
>>> class Color(Enum):
+...     RED = 1
+...     BLUE = 2
+...     GREEN = 3
+
+
+

Access them by:

+
    +

  • attribute access:

    +
    >>> Color.RED
+<Color.RED: 1>
+
    +
    +
    • +

  • value lookup:

    +
    >>> Color(1)
+<Color.RED: 1>
+
    +
    +
    • +

  • name lookup:

    +
    >>> Color['RED']
+<Color.RED: 1>
+
    +
    +
    • +
+

Enumerations can be iterated over, and know how many members they have:

+
>>> len(Color)
+3
+
+
+
>>> list(Color)
+[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]
+
+
+

Methods can be added to enumerations, and members can have their own +attributes – see the documentation for details.

+
+
+__and__(other: PluginState) → PluginState
+
+ +
+
+__eq__(other: object) → bool
+

Return self==value.

+
+ +
+
+__ge__(other: PluginState) → bool
+

Return self>=value.

+
+ +
+
+__gt__(other: PluginState) → bool
+

Return self>value.

+
+ +
+
+__int__() → int
+
+ +
+
+__invert__() → PluginState
+
+ +
+
+__le__(other: PluginState) → bool
+

Return self<=value.

+
+ +
+
+__lt__(other: PluginState) → bool
+

Return self<value.

+
+ +
+
+__ne__(other: object) → bool
+

Return self!=value.

+
+ +
+
+__or__(other: PluginState) → PluginState
+
+ +
+
+__rand__(other: PluginState) → PluginState
+
+ +
+
+__ror__(other: PluginState) → PluginState
+
+ +
+
+__rxor__(other: PluginState) → PluginState
+
+ +
+
+__str__() → str
+

Return str(self).

+
+ +
+
+__xor__(other: PluginState) → PluginState
+
+ +
+
+ACTIVE = Ellipsis
+
+ +
+
+INACTIVE = Ellipsis
+
+ +
+
+MISSING = Ellipsis
+
+ +
+
+property name: str
+

The name of the Enum member.

+
+ +
+
+property value: int
+

The value of the Enum member.

+
+ +
+ +
+
+class mobase.ProfileSetting(*args, **kwds)
+

Bases: enum.Enum

+

Create a collection of name/value pairs.

+

Example enumeration:

+
>>> class Color(Enum):
+...     RED = 1
+...     BLUE = 2
+...     GREEN = 3
+
+
+

Access them by:

+
    +

  • attribute access:

    +
    >>> Color.RED
+<Color.RED: 1>
+
    +
    +
    • +

  • value lookup:

    +
    >>> Color(1)
+<Color.RED: 1>
+
    +
    +
    • +

  • name lookup:

    +
    >>> Color['RED']
+<Color.RED: 1>
+
    +
    +
    • +
+

Enumerations can be iterated over, and know how many members they have:

+
>>> len(Color)
+3
+
+
+
>>> list(Color)
+[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]
+
+
+

Methods can be added to enumerations, and members can have their own +attributes – see the documentation for details.

+
+
+__and__(other: ProfileSetting) → ProfileSetting
+
+ +
+
+__eq__(other: object) → bool
+

Return self==value.

+
+ +
+
+__ge__(other: ProfileSetting) → bool
+

Return self>=value.

+
+ +
+
+__gt__(other: ProfileSetting) → bool
+

Return self>value.

+
+ +
+
+__int__() → int
+
+ +
+
+__invert__() → ProfileSetting
+
+ +
+
+__le__(other: ProfileSetting) → bool
+

Return self<=value.

+
+ +
+
+__lt__(other: ProfileSetting) → bool
+

Return self<value.

+
+ +
+
+__ne__(other: object) → bool
+

Return self!=value.

+
+ +
+
+__or__(other: ProfileSetting) → ProfileSetting
+
+ +
+
+__rand__(other: ProfileSetting) → ProfileSetting
+
+ +
+
+__ror__(other: ProfileSetting) → ProfileSetting
+
+ +
+
+__rxor__(other: ProfileSetting) → ProfileSetting
+
+ +
+
+__str__() → str
+

Return str(self).

+
+ +
+
+__xor__(other: ProfileSetting) → ProfileSetting
+
+ +
+
+CONFIGURATION = Ellipsis
+
+ +
+
+MODS = Ellipsis
+
+ +
+
+PREFER_DEFAULTS = Ellipsis
+
+ +
+
+SAVEGAMES = Ellipsis
+
+ +
+
+property name: str
+

The name of the Enum member.

+
+ +
+
+property value: int
+

The value of the Enum member.

+
+ +
+ +
+
+class mobase.ReleaseType(*args, **kwds)
+

Bases: enum.Enum

+

Create a collection of name/value pairs.

+

Example enumeration:

+
>>> class Color(Enum):
+...     RED = 1
+...     BLUE = 2
+...     GREEN = 3
+
+
+

Access them by:

+
    +

  • attribute access:

    +
    >>> Color.RED
+<Color.RED: 1>
+
    +
    +
    • +

  • value lookup:

    +
    >>> Color(1)
+<Color.RED: 1>
+
    +
    +
    • +

  • name lookup:

    +
    >>> Color['RED']
+<Color.RED: 1>
+
    +
    +
    • +
+

Enumerations can be iterated over, and know how many members they have:

+
>>> len(Color)
+3
+
+
+
>>> list(Color)
+[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]
+
+
+

Methods can be added to enumerations, and members can have their own +attributes – see the documentation for details.

+
+
+__eq__(other: object) → bool
+

Return self==value.

+
+ +
+
+__int__() → int
+
+ +
+
+__ne__(other: object) → bool
+

Return self!=value.

+
+ +
+
+__str__() → str
+

Return str(self).

+
+ +
+
+ALPHA = Ellipsis
+
+ +
+
+BETA = Ellipsis
+
+ +
+
+CANDIDATE = Ellipsis
+
+ +
+
+FINAL = Ellipsis
+
+ +
+
+PRE_ALPHA = Ellipsis
+
+ +
+
+property name: str
+

The name of the Enum member.

+
+ +
+
+property value: int
+

The value of the Enum member.

+
+ +
+ +
+
+class mobase.SaveGameInfo
+

Bases: GameFeature

+

Feature to get hold of stuff to do with save games.

+
+
+abstract getMissingAssets(save: ISaveGame) → Dict[str, Sequence[str]]
+

Retrieve missing assets from the save.

+
+
Parameters:
+

save – The save to find missing assets for.

+
+
Returns:
+

A collection of missing assets and the modules that can supply those assets.

+
+
+
+ +
+
+abstract getSaveGameWidget(parent: PyQt6.QtWidgets.QWidget) → ISaveGameInfoWidget | None
+

Retrieve a widget to display over the save game list.

+

This method is allowed to return None in case no widget has been implemented.

+
+
Parameters:
+

parent – The parent widget.

+
+
Returns:
+

A SaveGameInfoWidget to display information about save game.

+
+
+
+ +
+ +
+
+class mobase.ScriptExtender
+

Bases: GameFeature

+

Base class for all game features, cannot be inherited, used only for typing +purpose in Python.

+
+
+abstract binaryName() → str
+
+
Returns:
+

The name of the script extender binary.

+
+
+
+ +
+
+abstract getArch() → int
+
+
Returns:
+

The CPU platform of the extender.

+
+
+
+ +
+
+abstract getExtenderVersion() → str
+
+
Returns:
+

The version of the script extender.

+
+
+
+ +
+
+abstract isInstalled() → bool
+
+
Returns:
+

True if the script extender is installed, False otherwise.

+
+
+
+ +
+
+abstract loaderName() → str
+
+
Returns:
+

The loader to use to ensure the game runs with the script extender.

+
+
+
+ +
+
+abstract loaderPath() → str | os.PathLike[str] | PyQt6.QtCore.QFileInfo
+
+
Returns:
+

The full path to the script extender loader.

+
+
+
+ +
+
+abstract pluginPath() → str | os.PathLike[str] | PyQt6.QtCore.QDir
+
+
Returns:
+

The script extender plugin path, relative to the data folder.

+
+
+
+ +
+
+abstract savegameExtension() → str
+

Retrieve the extension of script extender save files.

+
+
Returns:
+

The extension of script extender save files (e.g. “skse”).

+
+
+
+ +
+ +
+
+class mobase.SortMechanism(*args, **kwds)
+

Bases: enum.Enum

+

Create a collection of name/value pairs.

+

Example enumeration:

+
>>> class Color(Enum):
+...     RED = 1
+...     BLUE = 2
+...     GREEN = 3
+
+
+

Access them by:

+
    +

  • attribute access:

    +
    >>> Color.RED
+<Color.RED: 1>
+
    +
    +
    • +

  • value lookup:

    +
    >>> Color(1)
+<Color.RED: 1>
+
    +
    +
    • +

  • name lookup:

    +
    >>> Color['RED']
+<Color.RED: 1>
+
    +
    +
    • +
+

Enumerations can be iterated over, and know how many members they have:

+
>>> len(Color)
+3
+
+
+
>>> list(Color)
+[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]
+
+
+

Methods can be added to enumerations, and members can have their own +attributes – see the documentation for details.

+
+
+__eq__(other: object) → bool
+

Return self==value.

+
+ +
+
+__int__() → int
+
+ +
+
+__ne__(other: object) → bool
+

Return self!=value.

+
+ +
+
+__str__() → str
+

Return str(self).

+
+ +
+
+BOSS = Ellipsis
+
+ +
+
+LOOT = Ellipsis
+
+ +
+
+MLOX = Ellipsis
+
+ +
+
+NONE = Ellipsis
+
+ +
+
+property name: str
+

The name of the Enum member.

+
+ +
+
+property value: int
+

The value of the Enum member.

+
+ +
+ +
+
+class mobase.TrackedState(*args, **kwds)
+

Bases: enum.Enum

+

Create a collection of name/value pairs.

+

Example enumeration:

+
>>> class Color(Enum):
+...     RED = 1
+...     BLUE = 2
+...     GREEN = 3
+
+
+

Access them by:

+
    +

  • attribute access:

    +
    >>> Color.RED
+<Color.RED: 1>
+
    +
    +
    • +

  • value lookup:

    +
    >>> Color(1)
+<Color.RED: 1>
+
    +
    +
    • +

  • name lookup:

    +
    >>> Color['RED']
+<Color.RED: 1>
+
    +
    +
    • +
+

Enumerations can be iterated over, and know how many members they have:

+
>>> len(Color)
+3
+
+
+
>>> list(Color)
+[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]
+
+
+

Methods can be added to enumerations, and members can have their own +attributes – see the documentation for details.

+
+
+__eq__(other: object) → bool
+

Return self==value.

+
+ +
+
+__ge__(other: TrackedState) → bool
+

Return self>=value.

+
+ +
+
+__gt__(other: TrackedState) → bool
+

Return self>value.

+
+ +
+
+__int__() → int
+
+ +
+
+__le__(other: TrackedState) → bool
+

Return self<=value.

+
+ +
+
+__lt__(other: TrackedState) → bool
+

Return self<value.

+
+ +
+
+__ne__(other: object) → bool
+

Return self!=value.

+
+ +
+
+__str__() → str
+

Return str(self).

+
+ +
+
+TRACKED_FALSE = Ellipsis
+
+ +
+
+TRACKED_TRUE = Ellipsis
+
+ +
+
+TRACKED_UNKNOWN = Ellipsis
+
+ +
+
+property name: str
+

The name of the Enum member.

+
+ +
+
+property value: int
+

The value of the Enum member.

+
+ +
+ +
+
+class mobase.UnmanagedMods
+

Bases: GameFeature

+

Base class for all game features, cannot be inherited, used only for typing +purpose in Python.

+
+
+abstract displayName(mod_name: str) → str
+

Retrieve the display name of a given mod.

+
+
Parameters:
+

mod_name – Internal name of the mod.

+
+
Returns:
+

The display name of the mod.

+
+
+
+ +
+
+abstract mods(official_only: bool) → Sequence[str]
+

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).

+
+
+
+ +
+
+abstract referenceFile(mod_name: str) → str | os.PathLike[str] | PyQt6.QtCore.QFileInfo
+

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.

+
+
+
+ +
+
+abstract secondaryFiles(mod_name: str) → Sequence[str | os.PathLike[str] | PyQt6.QtCore.QFileInfo]
+

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.

+
+
+
+ +
+ +
+
+class mobase.VersionInfo
+
+class mobase.VersionInfo(value: str, scheme: VersionScheme = VersionScheme.DISCOVER)
+
+class mobase.VersionInfo(major: int, minor: int, subminor: int, subsubminor: int, release_type: ReleaseType = ReleaseType.FINAL)
+
+class mobase.VersionInfo(major: int, minor: int, subminor: int, release_type: ReleaseType = ReleaseType.FINAL)
+

Represents the version of a mod or plugin.

+
+
+__eq__(other: object) → bool
+

Return self==value.

+
+ +
+
+__ge__(arg0: VersionInfo) → bool
+

Return self>=value.

+
+ +
+
+__gt__(arg0: VersionInfo) → bool
+

Return self>value.

+
+ +
+
+__le__(arg0: VersionInfo) → bool
+

Return self<=value.

+
+ +
+
+__lt__(arg0: VersionInfo) → bool
+

Return self<value.

+
+ +
+
+__ne__(other: object) → bool
+

Return self!=value.

+
+ +
+
+__str__() → str
+
+
Returns:
+

See canonicalString().

+
+
+
+ +
+
+canonicalString() → str
+
+
Returns:
+

A canonical string representing this version, that can be stored and then parsed using the parse() method.

+
+
+
+ +
+
+clear() → None
+

Resets this VersionInfo to an invalid version.

+
+ +
+
+displayString(forced_segments: int = 2) → str
+
+
Parameters:
+

forced_segments – The number of version segments to display even if the version is 0. 1 is major, 2 is major +and minor, etc. The only implemented ranges are (-inf,2] for major/minor, [3] for major/minor/subminor, +and [4,inf) for major/minor/subminor/subsubminor. This only versions with a regular scheme.

+
+
Returns:
+

A string for display to the user. The returned string may not contain enough information to reconstruct this version info.

+
+
+
+ +
+
+isValid() → bool
+
+
Returns:
+

True if this VersionInfo is valid, False otherwise.

+
+
+
+ +
+
+parse(value: str, scheme: VersionScheme = VersionScheme.DISCOVER, is_manual: bool = False) → None
+

Update this VersionInfo by parsing the given string using the given scheme.

+
+
Parameters:
+
    +

  • value – String to parse.

    • +

  • scheme – Scheme to use to parse the string.

    • +

  • is_manual – True if the given string should be treated as user input.

    • +
+
+
+
+ +
+
+scheme() → VersionScheme
+
+
Returns:
+

The version scheme in effect for this VersionInfo.

+
+
+
+ +
+ +
+
+class mobase.VersionScheme(*args, **kwds)
+

Bases: enum.Enum

+

Create a collection of name/value pairs.

+

Example enumeration:

+
>>> class Color(Enum):
+...     RED = 1
+...     BLUE = 2
+...     GREEN = 3
+
+
+

Access them by:

+
    +

  • attribute access:

    +
    >>> Color.RED
+<Color.RED: 1>
+
    +
    +
    • +

  • value lookup:

    +
    >>> Color(1)
+<Color.RED: 1>
+
    +
    +
    • +

  • name lookup:

    +
    >>> Color['RED']
+<Color.RED: 1>
+
    +
    +
    • +
+

Enumerations can be iterated over, and know how many members they have:

+
>>> len(Color)
+3
+
+
+
>>> list(Color)
+[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]
+
+
+

Methods can be added to enumerations, and members can have their own +attributes – see the documentation for details.

+
+
+__eq__(other: object) → bool
+

Return self==value.

+
+ +
+
+__int__() → int
+
+ +
+
+__ne__(other: object) → bool
+

Return self!=value.

+
+ +
+
+__str__() → str
+

Return str(self).

+
+ +
+
+DATE = Ellipsis
+
+ +
+
+DECIMAL_MARK = Ellipsis
+
+ +
+
+DISCOVER = Ellipsis
+
+ +
+
+LITERAL = Ellipsis
+
+ +
+
+NUMBERS_AND_LETTERS = Ellipsis
+
+ +
+
+REGULAR = Ellipsis
+
+ +
+
+property name: str
+

The name of the Enum member.

+
+ +
+
+property value: int
+

The value of the Enum member.

+
+ +
+ +
+
+mobase.getFileVersion(filepath: str | os.PathLike[str] | PyQt6.QtCore.QFileInfo) → str
+

Retrieve the file version of the given executable.

+
+
Parameters:
+

filepath – Absolute path to the executable.

+
+
Returns:
+

The file version, or an empty string if the file version could not be retrieved.

+
+
+
+ +
+
+mobase.getIconForExecutable(executable: str | os.PathLike[str] | PyQt6.QtCore.QFileInfo) → PyQt6.QtGui.QIcon
+

Retrieve the icon of an executable. Currently this always extracts the biggest icon.

+
+
Parameters:
+

executable – Absolute path to the executable.

+
+
Returns:
+

The icon for this executable, if any.

+
+
+
+ +
+
+mobase.getProductVersion(executable: str | os.PathLike[str] | PyQt6.QtCore.QFileInfo) → str
+

Retrieve the product version of the given executable.

+
+
Parameters:
+

executable – Absolute path to the executable.

+
+
Returns:
+

The product version, or an empty string if the product version could not be retrieved.

+
+
+
+ +
+
+mobase.GameFeatureType
+
+ +
+
+mobase.INVALID_HANDLE_VALUE: int = Ellipsis
+
+ +
+
+mobase.MoVariant
+
+ +
+
+mobase.__version__ = '2.5.2'
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/autoapi/mobase/widgets/index.html b/autoapi/mobase/widgets/index.html new file mode 100644 index 0000000..15520d4 --- /dev/null +++ b/autoapi/mobase/widgets/index.html @@ -0,0 +1,418 @@ + + + + + + + mobase.widgets — MO2 Python Plugin API documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

mobase.widgets

+
+

Attributes

+ + + + + + +

__version__

+
+
+

Classes

+ + + + + + + + + +

TaskDialog

Customizable choice dialog.

TaskDialogButton

Special button to be used inside TaskDialog widgets.

+
+
+

Package Contents

+
+
+class mobase.widgets.TaskDialog(parent: PyQt6.QtWidgets.QWidget | None = None, title: str = '', main: str = '', content: str = '', details: str = '', icon: PyQt6.QtWidgets.QMessageBox.Icon = PyQt6.QtWidgets.QMessageBox.Icon.NoIcon, buttons: list[TaskDialogButton] = [], remember: str | tuple[str, str] = '')
+

Customizable choice dialog.

+
+
+addButton(button: TaskDialogButton) → TaskDialog
+

Add a custom button to this TaskDialog.

+
+
Parameters:
+

button – Button to add to the dialog.

+
+
+
+ +
+
+addContent(widget: PyQt6.QtWidgets.QWidget) → None
+

Add a custom widget content to this TaskDialog. Widget content are put between +content and buttons (above buttons).

+
+
Parameters:
+

widget – Widget to add.

+
+
+
+ +
+
+exec() → PyQt6.QtWidgets.QMessageBox.StandardButton
+

Display this dialog and wait for user-interaction to return. This is a blocking +function.

+
+
Returns:
+

The button clicked by the user. Without custom buttons, this return Ok,

+
+
+

otherwise it returns the button set in the TaskDialogButton.

+
+ +
+
+setContent(content: str) → TaskDialog
+

Set the top-level message of this dialog.

+
+
Parameters:
+

content – Top-level message to set.

+
+
+
+ +
+
+setDetails(details: str) → TaskDialog
+

Set the details for this TaskDialog.

+

The details are hidden by default and the user can display them by clicking +the “Details” button at the bottom of the TaskDialog.

+
+
Parameters:
+

details – Details content to display. Can be a multi-line string.

+
+
+
+ +
+
+setIcon(icon: PyQt6.QtWidgets.QMessageBox.Icon) → TaskDialog
+

Set the icon of the dialog.

+
+
Parameters:
+

icon – Icon of the dialog.

+
+
+
+ +
+
+setMain(main: str) → TaskDialog
+

Set the main message of the dialog. The main message is displayed at the top of +the dialog in large font.

+
+
Parameters:
+

main – Main message of the dialog.

+
+
+
+ +
+
+setRemember(action: str, file: str = '') → TaskDialog
+

Configure the dialog to remember user-choice.

+
+ +
+
+setTitle(title: str) → TaskDialog
+

Set the title of the dialog.

+
+
Parameters:
+

title – Title of the dialog.

+
+
+
+ +
+
+setWidth(width: int) → None
+

Set the width of the dialog.

+
+
Parameters:
+

width – Width of the dialog.

+
+
+
+ +
+ +
+
+class mobase.widgets.TaskDialogButton(text: str, description: str, button: PyQt6.QtWidgets.QMessageBox.StandardButton)
+
+class mobase.widgets.TaskDialogButton(text: str, button: PyQt6.QtWidgets.QMessageBox.StandardButton)
+

Special button to be used inside TaskDialog widgets.

+
+
+property button: PyQt6.QtWidgets.QMessageBox.StandardButton
+
+ +
+
+property description: str
+
+ +
+
+property text: str
+
+ +
+ +
+
+mobase.widgets.__version__ = '2.5.2'
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/faq.html b/faq.html index 0988d32..0dff445 100644 --- a/faq.html +++ b/faq.html @@ -23,7 +23,7 @@ - + @@ -106,237 +106,77 @@
  • 3. Why are my isinstance(x, QObject) and isinstance(y, QWidget) not working?
    • -
  • mobase API