Difference between revisions of "Add-on etiquette"
| Line 11: | Line 11: | ||
==Don't make people install your add-on before they read the important notes== | ==Don't make people install your add-on before they read the important notes== | ||
If you overwrite files or have special install instructions, let the user see the readme or the installation instructions first and then install it. That's especially important if you have special terms of use. | If you overwrite files or have special install instructions, let the user see the readme or the installation instructions first and then install it. That's especially important if you have special terms of use. | ||
| − | |||
| − | |||
| − | |||
==[[Bug report|Bug reports]] are good== | ==[[Bug report|Bug reports]] are good== | ||
Don't get angry if somebody reports only the bugs of your add-on instead of writing a good review. You did not find these bugs before releasing it, so it's your own fault that somebody can even post the bug reports. Also such bug reports are posted for improving your add-on, because somebody is really interested in it. | Don't get angry if somebody reports only the bugs of your add-on instead of writing a good review. You did not find these bugs before releasing it, so it's your own fault that somebody can even post the bug reports. Also such bug reports are posted for improving your add-on, because somebody is really interested in it. | ||
Revision as of 16:39, 21 May 2013
This article is not meant as a set of rules which you have to follow by any means. It's more like a set of guidelines, which are meant to make your add-ons a bit more compatible to other add-ons and also make your life a bit easier when dealing with other developers.
The most important rule: Don't forget writing a manual
Even if you think using your add-on is the most trivial thing in the world - it usually isn't. A few lines about how to install and how to use it are sometimes enough, but they have to be there. Also make sure that somebody is able to read your manual. You have many (free) tools for creating good looking PDF format manuals. Use them. Don't put your documentation in Orbiter's root folder. There is a dedicated folder "doc" around for this task, but the folder "add-on docs" is also common. Don't name your manual "readme.txt". This file is often replaced soon by other add-ons.
Additionally, since Orbiter 2006, its possible to include compressed HTML files as online help for add-ons. This really makes it much easier to use your add-on, so its a good thing to do.
Don't violate the copyrights of other developers
You sure don't want for this to happen to you, and in most cases in our large add-on population, you can find very well done add-ons, which just want to be credited properly in your own credits, if you use them. Does it really harm somebody to write "These meshes were done by x y z"? No!
Don't make people install your add-on before they read the important notes
If you overwrite files or have special install instructions, let the user see the readme or the installation instructions first and then install it. That's especially important if you have special terms of use.
Bug reports are good
Don't get angry if somebody reports only the bugs of your add-on instead of writing a good review. You did not find these bugs before releasing it, so it's your own fault that somebody can even post the bug reports. Also such bug reports are posted for improving your add-on, because somebody is really interested in it.