Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split the "Importing 3D scenes" article into multiple pages #7830

Merged
merged 1 commit into from
Oct 6, 2023

Conversation

aaronfranke
Copy link
Member

@aaronfranke aaronfranke commented Aug 22, 2023

I was planning to add some more content to this article, but I noticed the article was getting super long and hard to navigate. This PR splits up this documentation article into 4 pages (plus an index page):

  • available_formats: Describes the available 3D formats and how to use them.
  • model_export_considerations: Describes conventions and best practices for exporting 3D models from Blender/etc.
  • node_type_customization: Describes how to customize node types using node name suffixes.
    • Note: The file name is purposefully a bit generic, because I want to expand this in the future with information about how to use glTF extensions to customize node types, in addition to node name suffixes.
  • import_configuration: Describes customizing the imported scene without modifying the file being imported.

The contents of these articles are exactly the same as the old unified article, the only difference in content is that I added some text to the headers of some of these files. I've collapsed them in the details below:

Added to index.rst:

Importing 3D scenes
===================

Godot supports importing 3D scenes from various file formats.
This documentation section describes what those formats are, and how to use
them, including exporting with the correct conventions and best practices,
and how to customize the node type using a suffix in the node name.
The import configuration article describes how to customize the
imported data using the import dock, the advanced import settings
dialog, and inherited scenes.

Added to model_export_considerations.rst:

Model export considerations
===========================

Before exporting a 3D model from a 3D modeling application, such as Blender,
there are some considerations that should be taken into account to ensure that
the model follows the conventions and best practices for Godot.

Added to import_configuration.rst:

Import configuration
====================

Godot provides several ways to customize the imported data, such as the
import dock, the advanced import setting dialog, and inherited scenes.
This can be used to make further changes to the imported scene, such
as adjusting meshes, adding physics information, and adding new nodes.
You can also write a script that runs code at the end of the import
process to perform arbitrary customization.

Note that, when applicable, modifying the original data should be preferred
to configuring the scene after import. This helps minimize the differences
between the 3D modeling application and the imported scene. See the
:ref:`doc_importing_3d_scenes_model_export_considerations` and
:ref:`doc_importing_3d_scenes_node_type_customization` articles
for more information.

Note: I'm still kind of a reStructured Text noob. I tried to structure it similar to other documentation, specifically using the ESCN importer code as an example. I also included a redirect.

and binary (``.glb``) formats.
- ``.blend`` (Blender). This works by calling Blender to export to glTF in a
transparent manner (requires Blender to be installed).
- DAE (COLLADA), an older format that is fully supported.
Copy link
Member

@fire fire Aug 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DAE (COLLADA), an older format that is fully supported.

There are open bugs regarding skeleton import, but we aren't able to deprecate Collada importer.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's the exact same text as currently in the docs.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

COLLADA is basically deprecated and has known issues, so support is poor. I would at a minimum remove the word "fully" since it is certainly not fully supported,
The biggest support issue is that skinned meshes are currently completely broken. See #68410.

@fire
Copy link
Member

fire commented Aug 22, 2023

/home/runner/work/godot-docs/godot-docs/classes/class_resourceimporterobj.rst:31:unknown document: ../tutorials/assets_pipeline/importing_scenes

Some cicd errors.

@aaronfranke
Copy link
Member Author

aaronfranke commented Aug 22, 2023

@fire CICD errors need godotengine/godot#80872 EDIT: Updated this PR with those changes.

@aaronfranke aaronfranke force-pushed the split-importing-3d-scenes branch from 3c9bd92 to 9f2ea05 Compare August 22, 2023 18:41
@aaronfranke aaronfranke force-pushed the split-importing-3d-scenes branch from 9f2ea05 to 52ce5d3 Compare August 30, 2023 06:48
@aaronfranke aaronfranke added this to the 4.2 milestone Sep 1, 2023
Copy link
Contributor

@lyuma lyuma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rename tutorials/assets_pipeline/{importing_scenes.rst => importing_3d_scenes/import_configuration.rst} (59%)

Renaming a documentation will cause a 404 error for all existing links to that page. It is good practice to add a redirect from the old page to the new one.

EDIT: I missed it but redirects.csv has the correct redirect already configured. It looks good!

There was one mistake with the seealso for FBX landing on the wrong page, but other than that it looks correct technically speaking.

I don't think we should act on changes to the text of the documentation. I was just replying to the thing fire noticed, and I noticed something thing about glb embedded but we can fix it in a separate PR.

and binary (``.glb``) formats.
- ``.blend`` (Blender). This works by calling Blender to export to glTF in a
transparent manner (requires Blender to be installed).
- DAE (COLLADA), an older format that is fully supported.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

COLLADA is basically deprecated and has known issues, so support is poor. I would at a minimum remove the word "fully" since it is certainly not fully supported,
The biggest support issue is that skinned meshes are currently completely broken. See #68410.

@aaronfranke aaronfranke force-pushed the split-importing-3d-scenes branch from 52ce5d3 to f4aff64 Compare September 5, 2023 08:14
Copy link
Contributor

@lyuma lyuma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! I see the redirect in redirects.csv so it should work.

@adamscott
Copy link
Member

adamscott commented Sep 15, 2023

@akien-mga @YuriSizov
To merge with godotengine/godot#80872

aaronfranke added a commit to aaronfranke/godot that referenced this pull request Sep 24, 2023
@aaronfranke aaronfranke force-pushed the split-importing-3d-scenes branch from f4aff64 to 8c61040 Compare September 24, 2023 21:09
Copy link

@Scoppio Scoppio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good split.

Copy link
Contributor

@skyace65 skyace65 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did I miss a change recently? I thought we weren't supposed to update class reference pages in the docs repository.

@aaronfranke
Copy link
Member Author

@skyace65 An identical change has been made on the main repo. godotengine/godot#80872

This is the only way to do it. It's a mid-air conflict with the main repo referencing the docs.

Copy link
Contributor

@skyace65 skyace65 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only issues I could find with this. Everything else looks perfect.

@aaronfranke aaronfranke force-pushed the split-importing-3d-scenes branch from 8c61040 to 7d9ab84 Compare October 1, 2023 18:11
@skyace65 skyace65 merged commit 5d47cec into godotengine:master Oct 6, 2023
@skyace65
Copy link
Contributor

skyace65 commented Oct 6, 2023

Thanks! I merged the PR in the engine repository as well.

@aaronfranke aaronfranke deleted the split-importing-3d-scenes branch October 6, 2023 03:05
@aaronfranke aaronfranke added area:manual Issues and PRs related to the Manual/Tutorials section of the documentation topic:import labels Oct 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement topic:import
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants