DO NOT SUBMIT TO THIS REPOSITORY
This repository has been deprecated by DalamudPluginsD17, which offers a much simpler submission and review process.
If DalamudPluginsD17 does not meet your requirements, please contact us and we can work something out.
The original README follows after the cut.
Dalamud plugin repository
This repository hosts plugin binaries that are used with Dalamud, which is managed by FFXIVQuickLauncher.
They are made and maintained by third party developers. Plugins being on here doesn’t mean that we endorse them, it just means that they follow our rules/standards for submissions.
Installing Plugins
To install plugins, you’ll need to use XIVLauncher with the in-game addon (Dalamud) enabled. Once Dalamud has loaded, you can type /xlplugins in game to open a plugin installed.
You do not need to download any of the plugins here manually. Plugin installation is handled inside of the game directly.
Making a plugin
Please see the API documentation for information about creating plugins.
What should my plugin not do?
Make sure that your plugin does not directly interact with the game servers in a way that is:
a) automatic, as in polling data or making requests without direct interaction from the user.
b) outside of specification, as in allowing the player to do submit things to the server that would not be possible by normal means.
Publishing/updating your plugin
Create a pull request with your own subfolder in the plugins directory of this folder. It should be named the “internal” name(name of the DLL) of your plugin and contain a plugin definition file with the same name.
It should also contain a zip called “latest.zip” containing your plugin DLL, dependencies, resources and the plugin definition json in the same folder as the plugin DLL.
An icon for your plugin has to be in “YourPlugin/images/” as “icon.png”. The icon has to be representative of what your plugin does, ideally have transparency and be at max, 512 by 512 pixels.
When the AssemblyVersion of the locally installed plugin doesn’t match the “AssemblyVersion” field of the plugin definition json pushed to this repository, a redownload of the plugin is forced.
For a sample of this, please see my sample plugin.
Plugin testing
When releasing a new plugin or making bigger changes, please PR your plugin inside the testing folder on this repository first - this lets users that opt into receiving testing releases see the plugin in their installer. You can join our Discord server to make an announcement in our testers channel.
This should usually not take more than a week - but it helps weeding out bigger issues that could cause crashes or prevent the plugin from being updated.
When submitting a plugin, please consider our Acceptable Use Policy & Terms of Service, which, for example, detail the rights you need to grant us when uploading a plugin to this repository.
评论