-
Notifications
You must be signed in to change notification settings - Fork 18
Mod Organizer Plugin Directory
The current plugin directory is located at /src/pluginfinder/pluginfinder_directory.json
To add your plugin to Plugin Finder or update an existing plugin, you have two options;
- Make the edit yourself and open a pull request, which I will check and approve as soon as I see it.
- Open a new issue with the details needed to add an entry and I will make the change when I get a chance, but this may take longer than a pull request.
The following is an example plugin entry in the directory
{
"Id": "rootbuilder",
"Name": "Root Builder",
"Description": "Root Builder is a Mod Organizer 2 plugin that allows you to manage files in the base game folder, not just the Data folder.",
"Author": "Kezyma",
"Nexus": "https://www.nexusmods.com/skyrimspecialedition/mods/31720",
"Github": "https://github.com/Kezyma/ModOrganizer-Plugins",
"Download": "https://github.com/Kezyma/ModOrganizer-Plugins/releases/download/Current/rootbuilder.zip",
"Path": [ "rootbuilder" ],
"Data": [ "data/rootbuilder" ]
},
This is the unique id for your plugin, once it has been set, it must not be changed in the future. Ideally it should be an all lowercase string containing letters and no whitespace.
The display name of the plugin.
A short description of what the plugin does, this needs to fit inside two lines in Plugin Finder, so take a look at how long current descriptions are before writing one.
The name of the plugin author.
A link to the Nexus page for the plugin, or an empty string if there is no page.
A link to the Github page for the plugin, or an empty string if there is no page.
Must be a direct download link to a zip file containing the plugin.
An array of files or folders inside the download zip, pointing to the plugin file or folder. Any files or folders listed here will be installed to the ModOrganizer\plugins folder.
An array of files or folders that the plugin may create to store data in. Leave empty if there are none. Any files or folders specified here will be deleted when the plugin is uninstalled. Paths should be relative to the ModOrganizer\plugins folder.