AcademySoftwareFoundation / AcademySoftwareFoundation/MaterialX
Documentation for adding custom nodes to MaterialXView
- Dominant language
- C++
- Stars
- 2.3k
- Forks
- 451
- Avg merge
- 6d 6h
- Merged PRs (30d)
- 5
Description
New developers and artists are often interested in viewing custom MaterialX nodes such as OpenPBR Surface in the MaterialX Viewer, but we don't currently provide instructions for this.
This task covers additional work to document best practices for viewing custom nodes in the MaterialX Viewer, building upon the documentation found here:
https://github.com/AcademySoftwareFoundation/MaterialX/blob/main/documents/DeveloperGuide/Viewer.md
A good starting point for this documentation would be the Slack thread on viewing OpenPBR Surface in the MaterialX Viewer, which may be found here:
https://academysoftwarefdn.slack.com/archives/C06365EAQMP/p1699834345302429
Contributor guide
Research direction
Start with documents/DeveloperGuide/Viewer.md and review the linked Slack thread about viewing OpenPBR Surface in the MaterialX Viewer. Document best practices and instructions for viewing custom MaterialX nodes, with completion defined by an added section that addresses the stated workflow.
Written by the indexing model from the issue text.
Assessment
- Domain
- computer-graphics, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100