-
-
Notifications
You must be signed in to change notification settings - Fork 35.3k
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
NodeMaterial documentation #17971
Comments
|
@donmccurdy @sunag @mrdoob I know this issue is VERY old but there is still a TON of active stuff going on with Nodes (137/138 with the editor additions) As has been mentioned before, the codebase has very little commenting and sometimes can be very confusing. For example, From the get-go there are multiple examples that load nodes from multiple different "Nodes" folder. Trying to figure out what everything is, how everything works and determine what "best practice" is is very difficult at the moment when I'm not even sure what the current supported nodes are and what the correct schema is for things. Something minimal to start I think would be a simple list with the eventual goal to be similar to How Babylon's Nodes are listed I'm pretty interested in this and am willing to help with docs/examples/etc but at the moment I'm not sure where to start nor what the plan/status/etc is... |
The "old" node material located in I would not yet start to document the new system in |
Right I saw the 138 notes and that's why I decided to reach out because something is happening with Nodes but from the outside it's a bit mythical.. I understand if you're doing a major refactor you don't want to be bound by legacy or issuing changes or maintaining technical documentation. But there's no legacy to worry about at this point. Who is doing the rapid Dev work?
Or are they working free flow? How can anyone get involved? If it's going to be black-box for a while is there a timeframe? At the very least having a schema and list/status of current nodes would be a good guide for both the devs as well as potential implementers. I'm not coming in and asking for a handout, I'm totally willing to put in effort, but where all this development is happening and what the goals/timeline/etc are is frustratingly difficult to decipher.. And if the people doing all the recent work off their own write ups and stuff it would give my efforts a significant starting point... |
@DennisSmolek I started developing |
Very awesome! Like I said I'm willing to put in the work and you don't have to make a perfect tech guide.
I've been trying to go through all the Recent PR's to catch up... |
@DennisSmolek in next release, some goals are:
There's a lot of open to finalize beside these, this might take a while to list, but I think any contribution would be of great help. |
I'd be willing to write documentation for node-based materials in three.js, but need to get a couple questions answered before I feel comfortable doing so.
StandardNodeMaterial
the material that should be documented, and notMeshStandardNodeMateral
? I believe that's true, based on [WIP] GLTFLoader: Add .setUseNodes() option. #14572 (comment) and the goal thatMeshStandardNodeMaterial
will just be a drop-in replacement forMeshStandardMaterial
but the docs would be very different if this is wrong.I'd prefer to document only one recommended material class, and one recommended syntax style, at the beginning — even if multiple will be available. I'm a bit nervous about having many syntax permutations in use so early with this API.
/cc @sunag @bhouston
The text was updated successfully, but these errors were encountered: