search

goatcorp / dalamud-docs

Dalamud developer documentation site
https://dalamud.dev/
MIT License
6 stars 21 forks source link

Document plugin manifests #25

Open sersorrel opened 4 months ago

sersorrel commented 4 months ago

substantially based on Franz's messages here: https://discord.com/channels/581875019861328007/860813266468732938/1212577414807429170

adjacent things that aren't included:

potentially this page's content as I've written it could plausibly live in the DalamudPackager readme? but the additional context about changelogs and icons, if I get round to writing it, definitely doesn't fit there

(sidenote: it looks like existing files are hard-wrapped at 80 columns but I can't see an editorconfig or similar to encourage that; I can add one if desired)

sersorrel commented 4 months ago

Changed the link to IPluginManifest, and added some details on changelogs.

I'm not 100% sure about the note about PR descriptions not being visible in the plugin installer – would be good to get confirmation that I've correctly interpreted the various related messages on Discord, XLWebServices/Plogon code, and the current changelogs of various plugins. (There's some further detail about nofranz that I considered documenting, but again it's annoyingly complex behaviour like "depending on whether nofranz is in the PR or in another location, and depending on whether it's at the start of the description or not, it will/won't post the Discord message and/or use the PR description as the changelog" that I don't really have any way of testing or verifying, and that most people won't make use of anyway.)

sersorrel commented 4 months ago

won't be able to get this updated til next week, sorry; I'll recheck what the state of things is then