General Question Prefered folder structure for add ons

[Topper]

Hello,

is there any "rule" how add on developers should create their add on structure?

Some add ons have their docs here, some add on docs are in another folder.
Sometimes the sources are in the Orbiter\Orbitersdk\Source folder, sometimes in the sample folder.

It does not bother me much, but if there is a common agreement I will act accordingly by developing further add ons.

 

[Wishbone]

What I gleaned from other add-ons: the docs go into Doc\{name_of_add-on} folder or into Add-on Docs\{name_of_add-on} folder.

Sources are in Orbitersdk folder, I chose the least resistance path and put them into samples just like on my dev rig. The way sources are located is not IMHO critical, what is critical is, to my mind, the 1-to-1 correspondence between top archive folders and Orbiter, and clear documentation of any manual or potentially breaking modifications.

 

[Urwumpe]

If possible, put stuff into subfolders that fit, so you don't mess with files from other add-ons.

 

[Ripley]

Plus, if you must have a "readme.txt" file in your add-on root folder, it will overwrite original Orbiter readme.txt, so rename it to something else (add-on-name-readme.txt), as suggested here:
http://www.orbiter-forum.com/showthread.php?t=19136

 

[Urwumpe]

Add, if you want to be extremely tidy:

All constant data, that is only read, belongs into /config
While all that is variable should can into the scenario file or into a special sub-folder.
The reason is, that you can also produce roughly live-CDs with Orbiter, which have add-ons and other stuff on the CD and write only status into the working directory.

 

[Wishbone]

A question: if I set up a config file for the MFD (already done that, the reason is I need to know paths of SPICE kernels to load), can I put it into Modules\Plugin, or should it be placed into the Config directory?

 

[Urwumpe]

A question: if I set up a config file for the MFD (already done that, the reason is I need to know paths of SPICE kernels to load), can I put it into Modules\Plugin, or should it be placed into the Config directory?

Better into config

 

[Carmen A]

I always follow the current trend of folder naming, so as to prevent root Orbiter directory clutter and also to prevent "false" installations.

Although manual inspection of install files is always prudent, I do get annoyed when the addon is unpacked and the files are located in /orbiter/MyCoolAddon/mod

And yes, the readme.txt should be renamed to something descriptive of the addon and located in Doc directory. For those not using a mod manager like JGSME or similar, a file manifest in the addon readme is helpful (like what I done for last month's repaints and terrain work).