Plugin help files/descriptions

[Eliaquim]

Hi people!

Well, some of you may have noticed that I'm releasing my plugins. And there is a lot that is ready, but waiting for the release!

So, the worst part for me to make a plugin is the help file ^^''
And one of the problems for this to be the worst part for me is making this inside a JS file(for you to see in the plugin manager).
But I was wondering...
What do you think is best?
Still write the help files inside the plugin files, like the majority.

Spoiler: Standard way

OR
Write the help files in another file, like a pdf?

What do you prefer?
Please give me your opinions! ^^

 

[KoalaFrenzy]

Definitely in the .js. As an end user, I'm not going to want to have to save/open/find pdfs to look up what I can do with the plugin.

 

[TheoAllen]

The answer is simple. Is it complex? choose a dedicated external source (pdf, website, etc). Is it just a simple plugin? write it in the js file.

 

[Aesica]

Put the help in the js file. I agree it's a pain, but for anyone using your plugins, its a lot more convenient not to have to reference some external file somewhere on their machine. That said, I find it helpful how Yanfly's plugin help data is also on his wiki, but if you want to do that, it's best to do it in addition to the in-plugin help, not as a replacement for it.

 

[Shaz]

I'll say in the .js file, just because that's what everyone else is doing, and what everyone is used to. It will confuse people if they can't see help in the plugin manager and have to go somewhere else. I will also create a post that goes into more detail, and includes examples, that I may not think are necessary in the .js file.

You could do both, and include a URL in the js file that points to the pdf, but that's more work for you.

 

[HumanNinjaToo]

Personally, I prefer to be able to see the instructions in an outside file if the plugin has a lot of features involved. It's easier for me to click on that pdf or txt file for reference while I'm making changes to the game, than it is to have to close my database or event and open the plugin list to reference something. But again, this is probably dependent on how much the plugin does, and what options it has. If it's something simple, then a short description in the plugin is fine.

This is coming from a user of plugins, definitely not a creator of plugins.

 

[YoraeRasante]

as mentioned, better leave in the plugin.
in places where you can type, like noteboxes, scripts, plugin commands, etc you can just press f1 and it opens the helps on the plugins in the managers. that makes it pretty easy to access.

but of course, there are the more complex ones, you'd need to keep chcking all the time and look around a lot.
for those, a pdf or site or help on github seems better...
but it does not substitute the plugin's help. it is better to access externally, sure, but if you for some reason are not able to it is much better to just be able to check the internal help too.

 

[pasunna]

well... when I have 100+ plugin in my editor
I don't remember where I save the readme file for each one...