Deploying to master from @ 4f9e212b9379db74594505f730cb48584743a17e 🚀

_sources/api/mobase.EndorsedState.rst.txt

@@ -0,0 +1,23 @@
+EndorsedState
+=============
+
+.. currentmodule:: mobase
+
+.. autoclass:: EndorsedState
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~EndorsedState.ENDORSED_FALSE
+      ~EndorsedState.ENDORSED_NEVER
+      ~EndorsedState.ENDORSED_TRUE
+      ~EndorsedState.ENDORSED_UNKNOWN
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: ENDORSED_FALSE
+   .. autoattribute:: ENDORSED_NEVER
+   .. autoattribute:: ENDORSED_TRUE
+   .. autoattribute:: ENDORSED_UNKNOWN

_sources/api/mobase.IDownloadManager.rst.txt

@@ -6,32 +6,24 @@ IDownloadManager
 .. autoclass:: IDownloadManager
    :show-inheritance:
 
-   .. rubric:: Attributes Summary
-
-   .. autosummary::
-
-      ~IDownloadManager.downloadComplete
-      ~IDownloadManager.downloadFailed
-      ~IDownloadManager.downloadPaused
-      ~IDownloadManager.downloadRemoved
-
    .. rubric:: Methods Summary
 
    .. autosummary::
 
       ~IDownloadManager.downloadPath
+      ~IDownloadManager.onDownloadComplete
+      ~IDownloadManager.onDownloadFailed
+      ~IDownloadManager.onDownloadPaused
+      ~IDownloadManager.onDownloadRemoved
       ~IDownloadManager.startDownloadNexusFile
       ~IDownloadManager.startDownloadURLs
 
-   .. rubric:: Attributes Documentation
-
-   .. autoattribute:: downloadComplete
-   .. autoattribute:: downloadFailed
-   .. autoattribute:: downloadPaused
-   .. autoattribute:: downloadRemoved
-
    .. rubric:: Methods Documentation
 
    .. automethod:: downloadPath
+   .. automethod:: onDownloadComplete
+   .. automethod:: onDownloadFailed
+   .. automethod:: onDownloadPaused
+   .. automethod:: onDownloadRemoved
    .. automethod:: startDownloadNexusFile
    .. automethod:: startDownloadURLs

_sources/api/mobase.IInstallationManager.rst.txt

@@ -15,7 +15,6 @@ IInstallationManager
       ~IInstallationManager.extractFiles
       ~IInstallationManager.getSupportedExtensions
       ~IInstallationManager.installArchive
-      ~IInstallationManager.setURL
 
    .. rubric:: Methods Documentation
 
@@ -24,4 +23,3 @@ IInstallationManager
    .. automethod:: extractFiles
    .. automethod:: getSupportedExtensions
    .. automethod:: installArchive
-   .. automethod:: setURL

_sources/api/mobase.IModInterface.rst.txt

@@ -14,15 +14,39 @@ IModInterface
       ~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.remove
+      ~IModInterface.newestVersion
+      ~IModInterface.nexusId
+      ~IModInterface.notes
+      ~IModInterface.pluginSetting
+      ~IModInterface.pluginSettings
+      ~IModInterface.primaryCategory
       ~IModInterface.removeCategory
+      ~IModInterface.repository
       ~IModInterface.setGameName
       ~IModInterface.setIsEndorsed
-      ~IModInterface.setName
       ~IModInterface.setNewestVersion
       ~IModInterface.setNexusID
+      ~IModInterface.setPluginSetting
+      ~IModInterface.setUrl
       ~IModInterface.setVersion
+      ~IModInterface.trackedState
+      ~IModInterface.url
+      ~IModInterface.validated
+      ~IModInterface.version
 
    .. rubric:: Methods Documentation
 
@@ -30,12 +54,36 @@ IModInterface
    .. 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:: remove
+   .. automethod:: newestVersion
+   .. automethod:: nexusId
+   .. automethod:: notes
+   .. automethod:: pluginSetting
+   .. automethod:: pluginSettings
+   .. automethod:: primaryCategory
    .. automethod:: removeCategory
+   .. automethod:: repository
    .. automethod:: setGameName
    .. automethod:: setIsEndorsed
-   .. automethod:: setName
    .. automethod:: setNewestVersion
    .. automethod:: setNexusID
+   .. automethod:: setPluginSetting
+   .. automethod:: setUrl
    .. automethod:: setVersion
+   .. automethod:: trackedState
+   .. automethod:: url
+   .. automethod:: validated
+   .. automethod:: version

_sources/api/mobase.IModList.rst.txt

@@ -11,10 +11,16 @@ IModList
    .. 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
@@ -22,10 +28,16 @@ IModList
    .. 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

_sources/api/mobase.IOrganizer.rst.txt

@@ -20,19 +20,23 @@ IOrganizer
       ~IOrganizer.findFiles
       ~IOrganizer.getFileOrigins
       ~IOrganizer.getGame
-      ~IOrganizer.getMod
+      ~IOrganizer.getPluginDataPath
       ~IOrganizer.installMod
+      ~IOrganizer.isPluginEnabled
       ~IOrganizer.listDirectories
       ~IOrganizer.managedGame
       ~IOrganizer.modDataChanged
       ~IOrganizer.modList
       ~IOrganizer.modsPath
-      ~IOrganizer.modsSortedByProfilePriority
       ~IOrganizer.onAboutToRun
       ~IOrganizer.onFinishedRun
-      ~IOrganizer.onModInstalled
+      ~IOrganizer.onPluginDisabled
+      ~IOrganizer.onPluginEnabled
       ~IOrganizer.onPluginSettingChanged
       ~IOrganizer.onProfileChanged
+      ~IOrganizer.onProfileCreated
+      ~IOrganizer.onProfileRemoved
+      ~IOrganizer.onProfileRenamed
       ~IOrganizer.onUserInterfaceInitialized
       ~IOrganizer.overwritePath
       ~IOrganizer.persistent
@@ -42,8 +46,7 @@ IOrganizer
       ~IOrganizer.profile
       ~IOrganizer.profileName
       ~IOrganizer.profilePath
-      ~IOrganizer.refreshModList
-      ~IOrganizer.removeMod
+      ~IOrganizer.refresh
       ~IOrganizer.resolvePath
       ~IOrganizer.setPersistent
       ~IOrganizer.setPluginSetting
@@ -62,19 +65,23 @@ IOrganizer
    .. automethod:: findFiles
    .. automethod:: getFileOrigins
    .. automethod:: getGame
-   .. automethod:: getMod
+   .. automethod:: getPluginDataPath
    .. automethod:: installMod
+   .. automethod:: isPluginEnabled
    .. automethod:: listDirectories
    .. automethod:: managedGame
    .. automethod:: modDataChanged
    .. automethod:: modList
    .. automethod:: modsPath
-   .. automethod:: modsSortedByProfilePriority
    .. automethod:: onAboutToRun
    .. automethod:: onFinishedRun
-   .. automethod:: onModInstalled
+   .. automethod:: onPluginDisabled
+   .. automethod:: onPluginEnabled
    .. automethod:: onPluginSettingChanged
    .. automethod:: onProfileChanged
+   .. automethod:: onProfileCreated
+   .. automethod:: onProfileRemoved
+   .. automethod:: onProfileRenamed
    .. automethod:: onUserInterfaceInitialized
    .. automethod:: overwritePath
    .. automethod:: persistent
@@ -84,8 +91,7 @@ IOrganizer
    .. automethod:: profile
    .. automethod:: profileName
    .. automethod:: profilePath
-   .. automethod:: refreshModList
-   .. automethod:: removeMod
+   .. automethod:: refresh
    .. automethod:: resolvePath
    .. automethod:: setPersistent
    .. automethod:: setPluginSetting

_sources/api/mobase.IPlugin.rst.txt

@@ -13,8 +13,10 @@ IPlugin
       ~IPlugin.author
       ~IPlugin.description
       ~IPlugin.init
-      ~IPlugin.isActive
+      ~IPlugin.localizedName
+      ~IPlugin.master
       ~IPlugin.name
+      ~IPlugin.requirements
       ~IPlugin.settings
       ~IPlugin.version
 
@@ -23,7 +25,9 @@ IPlugin
    .. automethod:: author
    .. automethod:: description
    .. automethod:: init
-   .. automethod:: isActive
+   .. automethod:: localizedName
+   .. automethod:: master
    .. automethod:: name
+   .. automethod:: requirements
    .. automethod:: settings
    .. automethod:: version

_sources/api/mobase.IPluginGame.rst.txt

@@ -14,6 +14,7 @@ IPluginGame
       ~IPluginGame.DLCPlugins
       ~IPluginGame.binaryName
       ~IPluginGame.dataDirectory
+      ~IPluginGame.detectGame
       ~IPluginGame.documentsDirectory
       ~IPluginGame.executableForcedLoads
       ~IPluginGame.executables
@@ -30,14 +31,13 @@ IPluginGame
       ~IPluginGame.iniFiles
       ~IPluginGame.initializeProfile
       ~IPluginGame.isInstalled
+      ~IPluginGame.listSaves
       ~IPluginGame.loadOrderMechanism
       ~IPluginGame.looksValid
       ~IPluginGame.nexusGameID
       ~IPluginGame.nexusModOrganizerID
       ~IPluginGame.primaryPlugins
       ~IPluginGame.primarySources
-      ~IPluginGame.savegameExtension
-      ~IPluginGame.savegameSEExtension
       ~IPluginGame.savesDirectory
       ~IPluginGame.setGamePath
       ~IPluginGame.setGameVariant
@@ -51,6 +51,7 @@ IPluginGame
    .. automethod:: DLCPlugins
    .. automethod:: binaryName
    .. automethod:: dataDirectory
+   .. automethod:: detectGame
    .. automethod:: documentsDirectory
    .. automethod:: executableForcedLoads
    .. automethod:: executables
@@ -67,14 +68,13 @@ IPluginGame
    .. automethod:: iniFiles
    .. automethod:: initializeProfile
    .. automethod:: isInstalled
+   .. automethod:: listSaves
    .. automethod:: loadOrderMechanism
    .. automethod:: looksValid
    .. automethod:: nexusGameID
    .. automethod:: nexusModOrganizerID
    .. automethod:: primaryPlugins
    .. automethod:: primarySources
-   .. automethod:: savegameExtension
-   .. automethod:: savegameSEExtension
    .. automethod:: savesDirectory
    .. automethod:: setGamePath
    .. automethod:: setGameVariant

_sources/api/mobase.IPluginInstaller.rst.txt

@@ -12,6 +12,8 @@ IPluginInstaller
 
       ~IPluginInstaller.isArchiveSupported
       ~IPluginInstaller.isManualInstaller
+      ~IPluginInstaller.onInstallationEnd
+      ~IPluginInstaller.onInstallationStart
       ~IPluginInstaller.priority
       ~IPluginInstaller.setInstallationManager
       ~IPluginInstaller.setParentWidget
@@ -20,6 +22,8 @@ IPluginInstaller
 
    .. automethod:: isArchiveSupported
    .. automethod:: isManualInstaller
+   .. automethod:: onInstallationEnd
+   .. automethod:: onInstallationStart
    .. automethod:: priority
    .. automethod:: setInstallationManager
    .. automethod:: setParentWidget

_sources/api/mobase.IPluginList.rst.txt

@@ -14,11 +14,13 @@ IPluginList
       ~IPluginList.loadOrder
       ~IPluginList.masters
       ~IPluginList.onPluginMoved
+      ~IPluginList.onPluginStateChanged
       ~IPluginList.onRefreshed
       ~IPluginList.origin
       ~IPluginList.pluginNames
       ~IPluginList.priority
       ~IPluginList.setLoadOrder
+      ~IPluginList.setPriority
       ~IPluginList.setState
       ~IPluginList.state
 
@@ -28,10 +30,12 @@ IPluginList
    .. automethod:: loadOrder
    .. automethod:: masters
    .. automethod:: onPluginMoved
+   .. automethod:: onPluginStateChanged
    .. automethod:: onRefreshed
    .. automethod:: origin
    .. automethod:: pluginNames
    .. automethod:: priority
    .. automethod:: setLoadOrder
+   .. automethod:: setPriority
    .. automethod:: setState
    .. automethod:: state

_sources/api/mobase.IPluginRequirement.rst.txt

@@ -0,0 +1,17 @@
+IPluginRequirement
+==================
+
+.. currentmodule:: mobase
+
+.. autoclass:: IPluginRequirement
+   :show-inheritance:
+
+   .. rubric:: Methods Summary
+
+   .. autosummary::
+
+      ~IPluginRequirement.check
+
+   .. rubric:: Methods Documentation
+
+   .. automethod:: check

_sources/api/mobase.IProfile.rst.txt

@@ -10,6 +10,7 @@ IProfile
 
    .. autosummary::
 
+      ~IProfile.absoluteIniFilePath
       ~IProfile.absolutePath
       ~IProfile.invalidationActive
       ~IProfile.localSavesEnabled
@@ -18,6 +19,7 @@ IProfile
 
    .. rubric:: Methods Documentation
 
+   .. automethod:: absoluteIniFilePath
    .. automethod:: absolutePath
    .. automethod:: invalidationActive
    .. automethod:: localSavesEnabled

_sources/api/mobase.ISaveGame.rst.txt

@@ -12,14 +12,14 @@ ISaveGame
 
       ~ISaveGame.allFiles
       ~ISaveGame.getCreationTime
-      ~ISaveGame.getFilename
+      ~ISaveGame.getFilepath
+      ~ISaveGame.getName
       ~ISaveGame.getSaveGroupIdentifier
-      ~ISaveGame.hasScriptExtenderFile
 
    .. rubric:: Methods Documentation
 
    .. automethod:: allFiles
    .. automethod:: getCreationTime
-   .. automethod:: getFilename
+   .. automethod:: getFilepath
+   .. automethod:: getName
    .. automethod:: getSaveGroupIdentifier
-   .. automethod:: hasScriptExtenderFile

_sources/api/mobase.PluginRequirementFactory.rst.txt

@@ -0,0 +1,23 @@
+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

_sources/api/mobase.SaveGameInfo.rst.txt

@@ -11,13 +11,9 @@ SaveGameInfo
    .. autosummary::
 
       ~SaveGameInfo.getMissingAssets
-      ~SaveGameInfo.getSaveGameInfo
       ~SaveGameInfo.getSaveGameWidget
-      ~SaveGameInfo.hasScriptExtenderSave
 
    .. rubric:: Methods Documentation
 
    .. automethod:: getMissingAssets
-   .. automethod:: getSaveGameInfo
    .. automethod:: getSaveGameWidget
-   .. automethod:: hasScriptExtenderSave

_sources/api/mobase.ScriptExtender.rst.txt

@@ -17,7 +17,7 @@ ScriptExtender
       ~ScriptExtender.isInstalled
       ~ScriptExtender.loaderName
       ~ScriptExtender.loaderPath
-      ~ScriptExtender.saveGameAttachmentExtensions
+      ~ScriptExtender.savegameExtension
 
    .. rubric:: Methods Documentation
 
@@ -28,4 +28,4 @@ ScriptExtender
    .. automethod:: isInstalled
    .. automethod:: loaderName
    .. automethod:: loaderPath
-   .. automethod:: saveGameAttachmentExtensions
+   .. automethod:: savegameExtension

_sources/api/mobase.TrackedState.rst.txt

@@ -0,0 +1,21 @@
+TrackedState
+============
+
+.. currentmodule:: mobase
+
+.. autoclass:: TrackedState
+   :show-inheritance:
+
+   .. rubric:: Attributes Summary
+
+   .. autosummary::
+
+      ~TrackedState.TRACKED_FALSE
+      ~TrackedState.TRACKED_TRUE
+      ~TrackedState.TRACKED_UNKNOWN
+
+   .. rubric:: Attributes Documentation
+
+   .. autoattribute:: TRACKED_FALSE
+   .. autoattribute:: TRACKED_TRUE
+   .. autoattribute:: TRACKED_UNKNOWN

_sources/setup-tools.rst.txt

@@ -84,6 +84,63 @@ And then add the following to ``settings.json`` (with the correct path):
 2. You can set the ``MYPYPATH`` environment variable to ``$MO2DIR\plugins\data`` (this requires
 restarting VS code).
 
+4. [Optional] Automatically reload plugins during development
+.............................................................
+
+This section is optional and requires you to already have written a "working"
+plugin (a plugin that MO2 can load).
+
+Since MO2 2.4 alpha 6, a new command has been added to ``ModOrganizer.exe`` to
+reload plugins during execution.
+If your plugin is named "My Plugin", you can use the following command to reload
+it while MO2 is running:
+
+.. code::
+
+    $MO2DIR\ModOrganizer.exe reload-plugin "My Plugin"
+
+If you are using Visual Studio Code, you can send this command to MO2 automatically
+after saving files from your project.
+
+1. Create a "reload plugin" task in Visual Studio Code (Ctrl+Shift+P  then
+   ``Tasks: Configure task`` or open ``.vscode/tasks.json``) using the following
+   snippet (replace the name and directory as needed):
+
+.. code::
+
+    // .vscode/tasks.json
+    {
+        // See https://go.microsoft.com/fwlink/?LinkId=733558
+        // for the documentation about the tasks.json format
+        "version": "2.0.0",
+        "tasks": [
+            {
+                "label": "reload plugin",
+                "type": "shell",
+                "command": "$MO2DIR/ModOrganizer.exe",
+                "args": [
+                    "reload-plugin", "My Plugin"
+                ]
+            }
+        ]
+    }
+
+2. Install the `Trigger Task on Save <https://marketplace.visualstudio.com/items?itemName=Gruntfuggly.triggertaskonsave>`_
+   extension from Visual Studio Code marketplace.
+
+3. Add the following to your Visual Studio Code settings (``.vscode/settings.json``)
+
+.. code::
+    // .vscode/settings.json
+    {
+        "triggerTaskOnSave.on": true,
+        "triggerTaskOnSave.tasks": {
+            "reload plugin": [
+                "*.py"
+            ]
+        }
+    }
+
 Testing the setup
 -----------------
 
@@ -128,8 +185,8 @@ If your setup is valid, here is what you should have.
 
 .. image:: images/check-setup-3.png
 
-If everything is as above, you can delete the test file and move on to writting
+If everything is as above, you can delete the test file and move on to writing
 your own plugin!
 
 
-.. |error-window| image:: images/error-window.png
+.. |error-window| image:: images/error-window.png