KhronosGroup / KhronosGroup/3D-Formats-Guidelines

Consider updating KTXArtistGuide to not use `toktx`

Open
#26 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
150
Forks
22
PR merge metrics
No merged PRs in 30d

Description

The [Compression Examples](https://github.com/KhronosGroup/3D-Formats-Guidelines/blob/main/KTXArtistGuide.md#compression-examples) section in the `KTXArtistGuide` refers to several function calls of `toktx`. One could see this as documenting the process that was _actually used_ for generating that specific "StainedGlassLamp" asset. But the `toktx` command has been replaced with specialized commands quite a while ago (see the list at https://github.khronos.org/KTX-Software/ktxtools/index.html ). Maybe this should be updated to use the new commands instead.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start in KTXArtistGuide.md at the Compression Examples section and review the linked KTX-Software tool list. Determine which specialized commands replace the documented toktx calls, then update the examples so they reflect the current tools and still describe the StainedGlassLamp asset process.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.