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

Update resource importing documentation for Godot 4.0 #6782

Merged
merged 1 commit into from
Feb 27, 2023

Conversation

Calinou
Copy link
Member

@Calinou Calinou commented Feb 16, 2023

  • Add best practices for importing images and audio, such as texture size recommendations.

See #6800 for 3D import documentation updates.

@skyace65
Copy link
Contributor

Importing images is missing a newline at the end

@Calinou Calinou force-pushed the update-import-docs branch 2 times, most recently from b2cebc3 to 7313c4e Compare February 16, 2023 23:13
@Calinou Calinou added enhancement area:manual Issues and PRs related to the Manual/Tutorials section of the documentation labels Feb 17, 2023
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.

Looks good! Just needs a few fixes.

tutorials/assets_pipeline/import_process.rst Outdated Show resolved Hide resolved
tutorials/assets_pipeline/import_process.rst Outdated Show resolved Hide resolved
tutorials/assets_pipeline/import_process.rst Outdated Show resolved Hide resolved
tutorials/assets_pipeline/importing_images.rst Outdated Show resolved Hide resolved
Comment on lines +206 to +220
+---------------+---------------------+---------------------+---------------------+---------------------+---------------------+
| Texture size | Lossless | Lossy | VRAM Compressed | VRAM Uncompressed | Basis Universal |
+===============+=====================+=====================+=====================+=====================+=====================+
| **128×128** | |good| 85 KiB | |good| 85 KiB | |good| 21 KiB | |good| 85 KiB | |good| 21 KiB |
+---------------+---------------------+---------------------+---------------------+---------------------+---------------------+
| **256×256** | |good| 341 KiB | |good| 341 KiB | |good| 85 KiB | |good| 341 KiB | |good| 85 KiB |
+---------------+---------------------+---------------------+---------------------+---------------------+---------------------+
| **512×512** | |good| 1.33 MiB | |good| 1.33 MiB | |good| 341 KiB | |good| 1.33 MiB | |good| 341 KiB |
+---------------+---------------------+---------------------+---------------------+---------------------+---------------------+
| **1024×1024** | |regular| 5.33 MiB | |regular| 5.33 MiB | |good| 1.33 MiB | |regular| 5.33 MiB | |good| 1.33 MiB |
+---------------+---------------------+---------------------+---------------------+---------------------+---------------------+
| **2048×2048** | |bad| 21.33 MiB | |bad| 21.33 MiB | |regular| 5.33 MiB | |bad| 21.33 MiB | |regular| 5.33 MiB |
+---------------+---------------------+---------------------+---------------------+---------------------+---------------------+
| **4096×4096** | |bad| 85.33 MiB | |bad| 85.33 MiB | |bad| 21.33 MiB | |bad| 85.33 MiB | |bad| 21.33 MiB |
+---------------+---------------------+---------------------+---------------------+---------------------+---------------------+
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure if we should be saying "good" or "bad," might be a better idea to just give the size and let people make their own decisions. The way this is made makes it seem like you should never use 4K textures.

Copy link
Member Author

@Calinou Calinou Feb 18, 2023

Choose a reason for hiding this comment

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

The "good" or "bad" badges are mostly for visual grepping; they're not visible as text on the page. Some people may also not be aware of how much VRAM usage they can get away with on typical target hardware, so hopefully this also gives an idea. (Obviously, this varies a lot on a project-by-project basis, but you'll run into problems if you create an indie game that requires a GPU with 6 GB of VRAM just to avoid running out of memory.)

There are good reasons to use 4K textures in some circumstances, but it's not something you should default to (as of writing).

This may be worth a dedicated paragraph on its own, but it may be more suited to the existing GPU optimization article. GPUs with 2-4 GB of VRAM are still quite common in the Steam Hardware Survey as of February 2023.

@Calinou Calinou force-pushed the update-import-docs branch 2 times, most recently from 7e15cae to a776f0d Compare February 18, 2023 01:22
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.

Looked over the stuff you changed and it looks good now. Just found 1 more issue.

tutorials/assets_pipeline/import_process.rst Outdated Show resolved Hide resolved
- Add best practices for importing images and audio, such as
  texture size recommendations.
@mhilbrunner mhilbrunner merged commit c8a306f into godotengine:master Feb 27, 2023
@mhilbrunner
Copy link
Member

Awesome, thanks! 🎉 Merged.

@mhilbrunner mhilbrunner added this to the Godot 4.0 milestone Feb 27, 2023
@Calinou Calinou deleted the update-import-docs branch February 27, 2023 17:09
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants