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

EditorExportPlugin docs: Workaround for customized texture behavior #94092

Merged
merged 1 commit into from
Nov 11, 2024

Conversation

allenwp
Copy link
Contributor

@allenwp allenwp commented Jul 8, 2024

EditorExportPlugin docs: Workaround for #94045. Describes behaviour of customizing texture resources.

The list of types that should not be both customized and skipped was created through trial-and-error with the following import types:

  • AnimationLibrary
  • BitMap
  • Translation
  • CompressedCubemap
  • CompressedCubemapArray
  • FontFile
  • FontFile
  • FontFile
  • RDShaderFile
  • Image
  • AudioStreamMP3
  • AudioStreamWAV
  • ArrayMesh
  • PackedScene
  • CompressedTexture2D
  • CompressedTexture2DArray
  • CompressedTexture3D
  • AtlasTexture
  • AudioStreamOggVorbis

The reason skip() should not be called is because the original resource will now point to the .ctex (or equivalent) file of the resource that replaced it. In this scenario, the .ctex file that was initially referenced by the original resource will no longer be included in the project.

From a usability perspective, there should be no difference between the way that different resources are handled, so I believe this is not a complete solution to the original issue. That said, my hope is that this documentation addition will at least bring EditorExportPlugin to a more usable state.

@allenwp allenwp requested a review from a team as a code owner July 8, 2024 18:10
@AThousandShips AThousandShips changed the title EditorExportPlugin docs: Workaround for #94045 (CompressedTexture2D behavior) EditorExportPlugin docs: Workaround for CompressedTexture2D behavior Jul 8, 2024
@AThousandShips AThousandShips added this to the 4.x milestone Jul 8, 2024
@allenwp allenwp force-pushed the editor-export-plugin-docs-94045 branch from ea67f93 to d741b2e Compare July 8, 2024 18:14
@akien-mga akien-mga requested a review from KoBeWi August 8, 2024 08:37
…behaviour of customizing texture resources.

The list of types that should not be both customized and skipped was created through trial-and-error with the following import types:

- AnimationLibrary
- BitMap
- Translation
- CompressedCubemap
- CompressedCubemapArray
- FontFile
- FontFile
- FontFile
- RDShaderFile
- Image
- AudioStreamMP3
- AudioStreamWAV
- ArrayMesh
- PackedScene
- CompressedTexture2D
- CompressedTexture2DArray
- CompressedTexture3D
- AtlasTexture
- AudioStreamOggVorbis

The reason `skip()` should not be called is because the original resource will now point to the `.ctex` (or equivalent) file of the resource that replaced it. In this scenario, the `.ctex` file that was initially referenced by the original resource will no longer be included in the project.

Co-authored-by: Tomek <kobewi4e@gmail.com>
@allenwp allenwp force-pushed the editor-export-plugin-docs-94045 branch from e1dd85e to c6e994b Compare September 30, 2024 13:21
@allenwp
Copy link
Contributor Author

allenwp commented Sep 30, 2024

I've pushed an update to this PR that includes more types that should not be both customized and skipped. It is now ready for review and merging.

@allenwp allenwp changed the title EditorExportPlugin docs: Workaround for CompressedTexture2D behavior EditorExportPlugin docs: Workaround for customized texture behavior Sep 30, 2024
@KoBeWi KoBeWi modified the milestones: 4.x, 4.4 Oct 31, 2024
@Repiteo Repiteo merged commit 2cf5461 into godotengine:master Nov 11, 2024
19 checks passed
@Repiteo
Copy link
Contributor

Repiteo commented Nov 11, 2024

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants