MO2 Python Plugin API

Contents:

  • Setting up the environment
    • Required tools
    • Preparation
      • 1. Get the mobase stubs
      • 2. Configure Visual Studio Code for mobase
      • 3. [Optional] Configure black to auto-format your source files
      • 4. [Optional] Automatically reload plugins during development
    • Testing the setup
  • Type of Plugins
    • Installers
    • Previewers
    • Mod Page
    • Game
    • Tool
    • Proxies
    • Free Plugins
    • Extension Interfaces
      • Diagnose
      • File Mappings
  • Writing Plugins
    • Getting started
      • Single file plugins
      • Module Plugins
    • Writing the plugin
      • IPlugin interface
    • Examples
      • Tutorial Plugins
      • Official Plugins
      • Unofficial Plugins
    • Internationalization
      • Adding translation code
      • Generating Qt translation files
      • Translating
      • Distributing translations
  • FAQ
    • 1. Why is MO2 throwing an exception when I try to create a type inheriting one of MO2 class?
    • 2. How can I be sure to implement all the required methods when creating a plugin?
    • 3. Why are my isinstance(x, QObject) and isinstance(y, QWidget) not working?
  • mobase API
    • Functions
      • getFileVersion
        • getFileVersion()
      • getIconForExecutable
        • getIconForExecutable()
      • getProductVersion
        • getProductVersion()
    • Classes
      • BSAInvalidation
        • BSAInvalidation
      • DataArchives
        • DataArchives
      • EndorsedState
        • EndorsedState
      • ExecutableForcedLoadSetting
        • ExecutableForcedLoadSetting
      • ExecutableInfo
        • ExecutableInfo
      • FileInfo
        • FileInfo
      • FileTreeEntry
        • FileTreeEntry
      • GamePlugins
        • GamePlugins
      • GuessQuality
        • GuessQuality
      • GuessedString
        • GuessedString
      • IDownloadManager
        • IDownloadManager
      • IFileTree
        • IFileTree
      • IInstallationManager
        • IInstallationManager
      • IModInterface
        • IModInterface
      • IModList
        • IModList
      • IModRepositoryBridge
        • IModRepositoryBridge
      • IOrganizer
        • IOrganizer
      • IPlugin
        • IPlugin
      • IPluginDiagnose
        • IPluginDiagnose
      • IPluginFileMapper
        • IPluginFileMapper
      • IPluginGame
        • IPluginGame
      • IPluginInstaller
        • IPluginInstaller
      • IPluginInstallerCustom
        • IPluginInstallerCustom
      • IPluginInstallerSimple
        • IPluginInstallerSimple
      • IPluginList
        • IPluginList
      • IPluginModPage
        • IPluginModPage
      • IPluginPreview
        • IPluginPreview
      • IPluginRequirement
        • IPluginRequirement
      • IPluginTool
        • IPluginTool
      • IProfile
        • IProfile
      • ISaveGame
        • ISaveGame
      • ISaveGameInfoWidget
        • ISaveGameInfoWidget
      • InstallResult
        • InstallResult
      • LoadOrderMechanism
        • LoadOrderMechanism
      • LocalSavegames
        • LocalSavegames
      • Mapping
        • Mapping
      • ModDataChecker
        • ModDataChecker
      • ModDataContent
        • ModDataContent
      • ModRepositoryFileInfo
        • ModRepositoryFileInfo
      • ModState
        • ModState
      • PluginRequirementFactory
        • PluginRequirementFactory
      • PluginSetting
        • PluginSetting
      • PluginState
        • PluginState
      • ProfileSetting
        • ProfileSetting
      • ReleaseType
        • ReleaseType
      • SaveGameInfo
        • SaveGameInfo
      • ScriptExtender
        • ScriptExtender
      • SortMechanism
        • SortMechanism
      • TrackedState
        • TrackedState
      • UnmanagedMods
        • UnmanagedMods
      • VersionInfo
        • VersionInfo
      • VersionScheme
        • VersionScheme
MO2 Python Plugin API
  • Welcome to MO2 Python Plugin API’s documentation!
  • View page source

Welcome to MO2 Python Plugin API’s documentation!

Plugins are a way to extend Mod Organizers functionality. You can write plugins in either C++ or Python, theoretically with either being as powerful as the other. This documentation is dedicated to writting MO2 Python plugins.

Contents:

  • Setting up the environment
    • Required tools
    • Preparation
    • Testing the setup
  • Type of Plugins
    • Installers
    • Previewers
    • Mod Page
    • Game
    • Tool
    • Proxies
    • Free Plugins
    • Extension Interfaces
  • Writing Plugins
    • Getting started
    • Writing the plugin
    • Examples
    • Internationalization
  • FAQ
    • 1. Why is MO2 throwing an exception when I try to create a type inheriting one of MO2 class?
    • 2. How can I be sure to implement all the required methods when creating a plugin?
    • 3. Why are my isinstance(x, QObject) and isinstance(y, QWidget) not working?
  • mobase API
    • Functions
    • Classes
Next

© Copyright 2023, Holt59.

Built with Sphinx using a theme provided by Read the Docs.