Orbiter 2024 Launch readiness

[Urwumpe]

Looks like we have a winner.

 

[GLS]

I don't know which rpi that was, but the latest one apparently does about ~15 GFLOPS. Plus, it seems that even the integrated GPUs of the last decade are in the hundreds of GFLOPS.
So I think we could cut the GPU requirements to 50 GFLOPS minimum and 100 recommended, and forget about it for a while.

 

[Gondos]

I don't know which rpi that was, but the latest one apparently does about ~15 GFLOPS. Plus, it seems that even the integrated GPUs of the last decade are in the hundreds of GFLOPS.
So I think we could cut the GPU requirements to 50 GFLOPS minimum and 100 recommended, and forget about it for a while.

It's on a RPi3 with a "lightweight" OpenGL GC. The point is almost any processor can support the physics part, the real constraint is on the graphics client. Running the D3D9Client with atmospheric scattering is the most taxing part, but when lowering the settings I guess it could run anywhere.

 

[GLS]

So I just discovered that the Orbitersdk\doxygen\API_reference folder has "sources" for the API_Reference.pdf doc, adding tutorials and "how-to"s to that doc.
I'm inclined to move those texts (and images) to the Orbiter Developer Manual, thus consolidating addon development information into one doc, and leaving the API_Reference doc just to list the functions.
Any objections?

 

[n72.75]

So I just discovered that the Orbitersdk\doxygen\API_reference folder has "sources" for the API_Reference.pdf doc, adding tutorials and "how-to"s to that doc.
I'm inclined to move those texts (and images) to the Orbiter Developer Manual, thus consolidating addon development information into one doc, and leaving the API_Reference doc just to list the functions.
Any objections?

No, that sounds like an great idea.

 

[GLS]

So, D3D9 adds DrawOrbits and GenericCamera... should these be mentioned in the user manual? I'm inclined to mention the DrawOrbits (useful feature), but not the GenericCamera (more of a demonstration)... thoughts?

 

[GLS]

Just to clarify: the available graphics engines no longer show up in the Modules tab, but are instead listed in the "Graphics engine" combobox in the Video tab, correct?

 

[n72.75]

So, D3D9 adds DrawOrbits and GenericCamera... should these be mentioned in the user manual? I'm inclined to mention the DrawOrbits (useful feature), but not the GenericCamera (more of a demonstration)... thoughts?

I agree. DrawOrbits should probably get a mention, but GenericCamera can probably just have its code-comments be the documentation.

Just to clarify: the available graphics engines no longer show up in the Modules tab, but are instead listed in the "Graphics engine" combobox in the Video tab, correct?

This is correct.

 

[Buck Rogers]

So, D3D9 adds DrawOrbits and GenericCamera... should these be mentioned in the user manual? I'm inclined to mention the DrawOrbits (useful feature), but not the GenericCamera (more of a demonstration)... thoughts?

I found GenericCamera functional and useful (have used in one of my addons), and only discovererd it by accident. Seems a shame not to mention it if it's there, even if just a couple of words? Just my 2cents, no biggy.

On a side note, low priority, I use Shipedit a lot, often data is cut off (big meshes) because the window is not adjustable, also it would be nice to copy/paste. Any chance of an update?

 

[misha.physics]

If we say about the Generic Camera MFD, then I'd like to ask if it's possible to increase its frame rate (FPS) at least up to 60 FPS.

 

[GLS]

I found GenericCamera functional and useful (have used in one of my addons), and only discovererd it by accident. Seems a shame not to mention it if it's there, even if just a couple of words? Just my 2cents, no biggy.

It actually makes sense to talk about the D3D9 camera feature in the developer manual.... and as part of that mention the MFD... but someone needs to write that, as I'm out of words.

 

[garyw]

How does the GitHub work exactly, would there be a download page for an official release that could have links to texture packages needed to run the Orbiter ?

You should be able to do a readme file that gets displayed on the main page for the repo. On that you can have links to documentation, textures and so on.

 

[GLS]

You should be able to do a readme file that gets displayed on the main page for the repo. On that you can have links to documentation, textures and so on.

That exists already, and I've (partially) updated it in my documentation PR.

 

[johnnymanly]

I found GenericCamera functional and useful (have used in one of my addons), and only discovererd it by accident. Seems a shame not to mention it if it's there, even if just a couple of words? Just my 2cents, no biggy.

On a side note, low priority, I use Shipedit a lot, often data is cut off (big meshes) because the window is not adjustable, also it would be nice to copy/paste. Any chance of an update?

I'd like to see an updated Shipedit as well, if possible.

 

[GLS]

Documentation status point.
Still work left to do, but already solved many issues and updated many sections, so things are moving forward.

Of the 3 documents, the one that is the closest to being finished is the Orbiter Technical Reference, where only a doubt I have remains unanswered:
Page 52: is alpha/beta naming correct or they should match "aero tradition"? Any takers?

The next closest to the finish line is the Orbiter User Manual, where the big issues are the Credits section that still needs major work, plus the TransX info still needs to be moved over (first I need to figure out if this is legally possible).
And last, the Orbiter Developer Manual still needs some massaging of the sections to provide a coherent flow of information, and some (large) gaps need to be filled.

One common issue on these last 2 documents is lua and scripting, of which I know next to nothing. Plus, there where changes in this area recently, so I don't really know how to update these sections...

There is still the issue of "(re)branding": Martin's name has to remain of course, but some updating is needed. I've done some work in the Introduction section of Orbiter User Manual, but changes are also needed in the Launchpad.

So, as things stand, here are the 3 documents: https://gofile.io/d/w42gC2

PLEASE read them and find issues/errors/typos! We had Martin do this for us for many years, for free, and now it is our turn, so find some time and help Orbiter.

 

[N_Molson]

This is great! I suggest you add some spacing between paragraphs to make it a bit easier to read. As an example in the Developer Manual, the bottom of page 6 look a bit 'cramped'. A small space between each definition would help, or maybe a full line.

If we take page 9 (section 4. Scenario Files) of the same manual the text is 'breathing' better, because there's a line between each paragraph.

 

[GLS]

This is great! I suggest you add some spacing between paragraphs to make it a bit easier to read. As an example in the Developer Manual, the bottom of page 6 look a bit 'cramped'. A small space between each definition would help, or maybe a full line.

If we take page 9 (section 4. Scenario Files) of the same manual the text is 'breathing' better, because there's a line between each paragraph.

That particular section was added recently, and so I didn't really spend much time looking at the results, but yes that could have some empty lines added, or be turned into a list which adds spacing.

As for "macro formatting".... I gave up long ago. There will always be some empty spaces at the bottom of pages because there is not enough space for an image ("floating images" never worked for me, they always end up way off place, so I'd rather fix them explicitly at some point of the text). Anyway, we can spend lots of time making things all pretty, and then a small change shifts everything and we're back to square one.

 

[Arvil]

Orbiter User Manual, page 1, line 1: instalment should be installment.

 

[GLS]

Orbiter User Manual, page 1, line 1: instalment should be installment.

GB English vs US English... while I tend to use the US version, Martin wrote in GB English, which is used in the majority of the texts.
It results in a mix of "Englishes", but I'm not loosing any sleep over it.

 

[Arvil]

Didn’t realize that it was correct in British English. So, just ignore me.