godot-docs icon indicating copy to clipboard operation
godot-docs copied to clipboard

Add Documentation section that exposes Engine Architecture

Open azur-wolve opened this issue 3 years ago • 1 comments

version: 3.4.3

Issue description: There's no documentation about how the engine works.

Some map (using diagrams) of the engine layout/architecture; rendering pipeline, engine-server co-relation, etc. Also how the type-system relates to, and essential stuff that anyone should know (there's info out there, but it looks spread and hidden).

Just in case, there exists already something like that?

azur-wolve avatar Jun 15 '22 07:06 azur-wolve

This documentation already exists: https://docs.godotengine.org/en/stable/development/cpp/index.html

Please be more specific if you need documentation on a subject that isn't already covered.

The rendering pipeline is likely the main aspect that isn't covered in the documentation. There's been a few blog posts about it back in 2019-2020, but these are slightly outdated by now. Knowing how the rendering pipeline works isn't important for most people, but it's useful if you intend to write your own rendering backend. I think having documentation for things like https://github.com/godotengine/godot-docs/issues/4834 first is more important, still.

The audio and physics engines could also use internal documentation, but reduz is planning to create a video about how GodotPhysics works (no ETA).

Calinou avatar Jun 15 '22 14:06 Calinou

Closing per Calinou's comment and the lack of a response.

skyace65 avatar Mar 24 '24 02:03 skyace65