https://github.com/holt59/modorganizer-python_plugins

A list of python plugins intended mostly for plugin creators.
https://github.com/holt59/modorganizer-python_plugins

mo2-plugin

Last synced: 1 day ago
JSON representation

A list of python plugins intended mostly for plugin creators.

• Host: GitHub
• URL: https://github.com/holt59/modorganizer-python_plugins
• Owner: Holt59
• License: mit
• Created: 2020-06-14T09:11:06.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-03-08T15:28:18.000Z (10 months ago)
• Last Synced: 2024-11-10T01:43:32.262Z (about 2 months ago)
• Topics: mo2-plugin
• Language: Python
• Homepage:
• Size: 323 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Mod Organizer 2 - Python Plugins

This repository contains examples of python plugins for [Mod Organizer 2](https://github.com/ModOrganizer2/modorganizer).

## Available plugins

Each plugin is in its own folder, and you can install it by simply downloading [the archive](https://github.com/Holt59/modorganizer-python_plugins/archive/master.zip)

and extracting the corresponding folder to the `plugins/` folder of your MO2 installation.

:warning:   These plugins are not meant to be used by normal MO2 users but are examples to get plugin

developers started.

:information_source:   I tried to document each plugin as best as I could, so some plugins

might look overly commented. Some plugins requires to generate files using `PyQt5`, everything is

explained in the `README.md` in the folder.

## Common implementation details

There is currently two way to ship of Python plugin for Mod Organizer 2:

- Ship a single Python file (`.py`) and put it in the `plugins/` folder. The file should

 expose a `createPlugin()` or `createPlugins()` method that returns the created plugin or

 the list of created plugins.

- Ship a Python module (folder) containing the plugin and put it in the `plugins/` folder.

 This is now the recommended way if your plugins is made of multiple files or contains

 resources. This repository only contains example of this.

When using the second version, the `createPlugin()` or `createPlugins()` functions must be

exposed in the `__init__.py` file of the module. You should make sure to use relative

imports when importing sub-modules to avoid issues (see the various plugins).

*Note:* When using the simple `.py` file version, it is possible to ship resources or even

a whole module by having user put them in `plugins/data`, but that is not recommended

anymore.